home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilImage.z / ilImage
Encoding:
Text File  |  2002-10-03  |  156.1 KB  |  3,167 lines
  1.  
  2.  
  3.  
  4. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllIIIImmmmaaaaggggeeee - base class for the ImageVision Library toolkit
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilImage.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      ilImage is the base class for the ImageVision Library (IL) toolkit. All
  19.      IL image objects are derived from ilImage either directly or indirectly.
  20.      The ilImage base class abstracts the general concept of an image by
  21.      defining variables and functions common to all images. It defines image
  22.      parameters (e.g. size, data type), and provides access functions to query
  23.      and set them. It also provides functions to access image data. ilImage is
  24.      derived from ilLink so that images can be chained together, which allows
  25.      the output of one image operation to become the input to another.
  26.  
  27.      ilImage thus defines a common Application Program Interface (API).  This
  28.      means that, for example, image data can be obtained from any image object
  29.      by calling ggggeeeettttTTTTiiiilllleeee().
  30.  
  31.      UUUUssssiiiinnnngggg iiiillllIIIImmmmaaaaggggeeee
  32.  
  33.      ilImage is intended to be used as a base class for deriving new types of
  34.      images.  Because most of the image data access virtuals return the status
  35.      ilUNSUPPORTED, it is not useful to directly construct an ilImage object.
  36.      However, a pointer to an ilImage can be declared to reference an image of
  37.      unknown derivation.
  38.  
  39.      The ilImage class provides protected and public member functions. The
  40.      protected functions provide convenient services to derived classes,
  41.      (particularly for initializing and resetting an image's attributes) while
  42.      the public functions form the API.
  43.  
  44.      QQQQuuuueeeerrrryyyyiiiinnnngggg aaaannnndddd SSSSeeeettttttttiiiinnnngggg IIIImmmmaaaaggggeeee AAAAttttttttrrrriiiibbbbuuuutttteeeessss
  45.  
  46.      The size of an image in the _x, _y, _z and _c dimensions can be retrieved
  47.      using the function, ggggeeeettttSSSSiiiizzzzeeee().  In a typical 2-D image, z is 1 and the
  48.      number of channels (c) per pixel is 3 (red, green and blue, for example).
  49.      The image size is stored in a data object called iflSize. The size of the
  50.      image can be set using the function, sssseeeettttSSSSiiiizzzzeeee().
  51.  
  52.      The data type of the pixel channels can be retrieved using the function,
  53.      ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee().  It returns an enumerated type called _i_f_l_D_a_t_a_T_y_p_e, which
  54.      has members _i_f_l_C_h_a_r, _i_f_l_U_C_h_a_r, _i_f_l_F_l_o_a_t, and so forth.  The data type can
  55.      be set by passing an iflDataType to the member function, sssseeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee().
  56.  
  57.      The pixel channel order can be queried and set using ggggeeeettttOOOOrrrrddddeeeerrrr() and
  58.      sssseeeettttOOOOrrrrddddeeeerrrr(), respectively. This information is indicated with the
  59.      enumerated type, _i_f_l_O_r_d_e_r. _i_f_l_O_r_d_e_r has members _i_f_l_I_n_t_e_r_l_e_a_v_e_d,
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  71.  
  72.  
  73.  
  74.      _i_f_l_S_e_q_u_e_n_t_i_a_l and _i_f_l_S_e_p_a_r_a_t_e, which indicate how the pixel components
  75.      are stored.
  76.  
  77.      The orientation of an image can be queried and set using ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn()
  78.      and sssseeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn() respectively. The orientation of an image is
  79.      specified using the enumerated type, _i_f_l_O_r_i_e_n_t_a_t_i_o_n.  An orientation of
  80.      _i_f_l_L_o_w_e_r_L_e_f_t_O_r_i_g_i_n, for example, means that the origin of the image is
  81.      displayed in the lower left corner of the window.
  82.  
  83.      The color model of an image can be queried and set using ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll()
  84.      and sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll() functions, respectively.  The color model can be one
  85.      of the enumerated iflColorModel types.
  86.  
  87.      A color map can also be associated with an ilImage.  The color map can be
  88.      queried and set using the ggggeeeettttCCCCoooolllloooorrrrmmmmaaaapppp() and sssseeeettttCCCCoooolllloooorrrrmmmmaaaapppp() functions,
  89.      respectively.  The color map is defined by using an iflColormap object.
  90.  
  91.      In general, for each image attribute there are access functions to set or
  92.      get the associated member variables in class ilImage.
  93.  
  94.      AAAAcccccccceeeessssssssiiiinnnngggg IIIImmmmaaaaggggeeee DDDDaaaattttaaaa
  95.  
  96.      Image data can be accessed as pixels or as a rectangular region of
  97.      arbitrary size called a tile.  Both 2-D and 3-D tile access functions are
  98.      provided.
  99.  
  100.      The virtual access functions present a queued request model, which allows
  101.      an application to issue non-blocking requests for image I/O and later
  102.      inquire the status and/or wait for the operation to complete.  The queued
  103.      model also provides derived classes with the "hooks" needed to
  104.      automatically distribute operations across multiple processors. These
  105.      queued functions are distinguished by the prefix 'q' on the function
  106.      name.  For convenience, there are access functions which do wait for
  107.      their operation to complete, hiding the details of the queued model.
  108.  
  109.      There are several different functions to read image data, all based on
  110.      qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD().  Similarly, there are several different functions to
  111.      write image data based on qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD().  Two fast-paths called
  112.      qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg() and qqqqCCCCooooppppyyyyTTTTiiiilllleeee3333DDDD() are available for copying a tile from
  113.      another ilImage.
  114.  
  115.      When calling the base functions listed above, the caller must specify the
  116.      origin (x, y, z) and size (nx, ny, nz) of the desired tile.  For 2-D
  117.      operations, z is set to 0 and nz is set to 1.  For pixel operations, nx,
  118.      ny and nz are set to 1.  An object called iflConfig, is used to specify
  119.      the configuration (that is, data type, order, number of channels and so
  120.      forth) of the desired tile.  If required, the image data is converted to
  121.      a specified configuration while getting a tile, or converted from a
  122.      specified configuration to that of the image while setting a tile.
  123.  
  124.      CCCChhhhaaaaiiiinnnniiiinnnngggg IIIImmmmaaaaggggeeeessss
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  137.  
  138.  
  139.  
  140.      Images can be chained together, allowing the output from one image
  141.      operation to become the input to another image operation without an
  142.      intermediate buffer.  Each image can have multiple parents (inputs) and
  143.      multiple children (outputs). In addition to the functions inherited from
  144.      _i_l_L_i_n_k, several functions such as sssseeeettttIIIInnnnppppuuuutttt(), aaaaddddddddIIIInnnnppppuuuutttt() and
  145.      rrrreeeemmmmoooovvvveeeeIIIInnnnppppuuuutttt() are also provided to manage the input list.  Inputs are
  146.      usually added to an image in its constructor, although the input list can
  147.      be manipulated after the image has been created.
  148.  
  149.      The power of chaining is fully realized with image operators (see the
  150.      ilOpImg man page), which can be chained together to perform complex image
  151.      processing operations.  Chaining also allows a single image to be an
  152.      input to multiple output operators.
  153.  
  154.      DDDDeeeerrrriiiivvvviiiinnnngggg NNNNeeeewwww CCCCllllaaaasssssssseeeessss ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  155.  
  156.      Most new image classes should derive from ilMemCacheImg, ilOpImg,
  157.      ilPolyadicImg, or a derivative (see the relevant man page).  Some special
  158.      cases may require deriving directly from ilImage.
  159.  
  160.      When a new class is derived from ilImage, it should redefine some of the
  161.      inherited virtual functions.  It must define at least one of
  162.      qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(). The virtual function qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg()
  163.      should also be defined to provide a fast-path for copying a tile of image
  164.      data from one ilImage to another; the standard version stages the copy
  165.      through a temporary buffer, halving the potential performance.
  166.  
  167.  
  168.           qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((())))   Retrieves the specified tile of data in the given
  169.                             configuration from the image's input source.
  170.  
  171.           qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((())))   Stores the specified tile of data in the given
  172.                             configuration to the image's output destination.
  173.  
  174.           qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg(((())))    Copies the specified tile of data from another
  175.                             ilImage to this image.
  176.  
  177.           qqqqFFFFiiiillllllllTTTTiiiilllleeee3333DDDD(((())))     Fills a tile of the image with a constant pixel
  178.                             value.  qqqqFFFFiiiillllllllTTTTiiiilllleeeeRRRRGGGGBBBB(((()))) Also fills a tile, with the
  179.                             fill value specified as a red, green, blue
  180.                             triplet.
  181.  
  182.      In derived classes of ilImage, image attributes can be set using any of
  183.      the access functions after the creation of the image.  When image
  184.      attributes are changed, some parameters that depend on these attributes
  185.      may have to be recomputed, typically in a reset operation. ilImage uses
  186.      the ilLink flags and functions to manage and query the attributes' states
  187.      and provides a default implementation for the ilLink virtual function,
  188.      rrrreeeesssseeeetttt(((()))).  If a derived class must be notified when the image attributes
  189.      change, it will need to re-define the rrrreeeesssseeeetttt() virtual; for proper
  190.      operation, the derived reset must call the base class reset.  Operator
  191.      images (derived from ilOpImg) cannot re-define reset; they can define a
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  203.  
  204.  
  205.  
  206.      new rrrreeeesssseeeettttOOOOpppp() instead.  For more information on operator images and
  207.      resetOp, see the man page for ilOpImg.
  209. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  210.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  211.  
  212.           ilImage()
  213.           ilImage(iflSize &sz)
  214.  
  215.  
  216.      MMMMaaaannnniiiippppuuuullllaaaattttiiiinnnngggg iiiimmmmaaaaggggeeee iiiinnnnppppuuuuttttssss
  217.  
  218.           int getNumInputs()
  219.           void setNumInputs(int num)                            _p_r_o_t_e_c_t_e_d
  220.           ilStatus setInput(ilImage* inimg, int idx = 0)
  221.           ilStatus addInput(ilImage* inimg)
  222.           ilImage* getInput(int idx = 0)
  223.           ilStatus removeInput(int idx = 0)
  224.           ilImage* getDirectInput(int idx = 0)
  225.  
  226.  
  227.      SSSSttttoooorrrriiiinnnngggg aaaannnndddd rrrreeeettttrrrriiiieeeevvvviiiinnnngggg 3333DDDD iiiimmmmaaaaggggeeee ddddaaaattttaaaa
  228.  
  229.           ilStatus getSubTile3D(int x, int y, int z, int nx, int ny,
  230.                                 int nz, void* data, int dx, int dy, int dz,
  231.                                 int dnx, int dny, int dnz,
  232.                                 const ilConfig* config=NULL)
  233.  
  234.           virtual ilStatus qGetSubTile3D(ilMpNode* parent, int x, int y, int z,
  235.                                          int nx, int ny, int nz, void*& data,
  236.                                          int dx, int dy, int dz,
  237.                                          int dnx, int dny, int dnz,
  238.                                          const ilConfig* config=NULL,
  239.                                          ilMpManager** pMgr=NULL)
  240.           ilStatus setSubTile3D(int x, int y, int z, int nx, int ny,
  241.                                 int nz, const void* data, int dx, int dy, int dz,
  242.                                 int dnx, int dny, int dnz,
  243.                                 const ilConfig* config=NULL)
  244.  
  245.           virtual ilStatus qSetSubTile3D(ilMpNode* parent, int x, int y, int z,
  246.                                          int nx, int ny, int nz,
  247.                                          const void* data, int dx, int dy, int dz,
  248.                                          int dnx, int dny, int dnz,
  249.                                          const ilConfig* config=NULL,
  250.                                          ilMpManager** pMgr=NULL)
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  258.  
  259.  
  260.                                                                         PPPPaaaaggggeeee 4444
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  268.  
  269.  
  270.  
  271.           ilStatus copyTileCfg(int x, int y, int z, int nx, int ny,
  272.                               int nz, ilImage* other, int ox, int oy, int oz,
  273.                               const ilConfig* config=NULL)
  274.  
  275.           virtual ilStatus qCopyTileCfg(ilMpNode* parent, int x, int y, int z,
  276.                                         int nx, int ny, int nz,
  277.                                         ilImage* other, int ox, int oy, int oz,
  278.                                         const ilConfig* config=NULL,
  279.                                         ilMpManager** pMgr=NULL)
  280.  
  281.           ilStatus fillTile3D(int x, int y, int z, int nx, int ny, int nz,
  282.                               const void* data, const ilConfig* config=NULL,
  283.                               const iflTile2Dint* fillMask=NULL)
  284.  
  285.           virtual ilStatus qFillTile3D(ilMpNode* parent, int x, int y, int z,
  286.                                        int nx, int ny, int nz,
  287.                                        const void* data, const ilConfig* config=NULL,
  288.                                        const iflTile3Dint* fillMask=NULL,
  289.                                        ilMpManager** pMgr=NULL)
  290.  
  291.           ilStatus fillTileRGB(int x, int y, int z, int nx, int ny, int nz,
  292.                          float red, float green, float blue,
  293.                          const iflTile3Dint* fillMask=NULL,
  294.                          iflOrientation orientation=iflOrientation(0));
  295.  
  296.           virtual ilStatus qFillTileRGB(ilMpNode* parent, int x, int y, int z,
  297.                                         int nx, int ny, int nz,
  298.                                         float red, float green, float blue,
  299.                                         const iflTile3Dint* fillMask=NULL,
  300.                                         iflOrientation orientation=iflOrientation(0),
  301.                                         ilMpManager** pMgr=NULL)
  302.  
  303.           ilStatus copyTile3D(int x, int y, int z, int nx, int ny, int nz,
  304.                               ilImage* other, int ox, int oy, int oz,
  305.                               int* chanList=NULL)
  306.  
  307.           ilStatus copy(ilImage* from)
  308.  
  309.           ilStatus getTile3D(int x, int y, int z, int nx, int ny,
  310.                              int nz, void* data, const ilConfig* config=NULL)
  311.  
  312.           ilStatus qGetTile3D(ilMpNode* parent, int x, int y, int z,
  313.                               int nx, int ny, int nz, void*& data,
  314.                               const ilConfig* config=NULL, ilMpManager** pMgr=NULL)
  315.  
  316.           ilStatus setTile3D(int x, int y, int z, int nx, int ny, int nz,
  317.                              const void* data, const ilConfig* config=NULL)
  318.  
  319.           ilStatus getPixel3D(int x, int y, int z, iflPixel& pix)
  320.  
  321.           ilStatus setPixel3D(int x, int y, int z, iflPixel& pix)
  322.  
  323.  
  324.  
  325.  
  326.                                                                         PPPPaaaaggggeeee 5555
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  334.  
  335.  
  336.  
  337.      SSSSttttoooorrrriiiinnnngggg aaaannnndddd rrrreeeettttrrrriiiieeeevvvviiiinnnngggg 2222----DDDD iiiimmmmaaaaggggeeee ddddaaaattttaaaa
  338.  
  339.           ilStatus getTile(int x, int y, int nx, int ny, void* data,
  340.                            const ilConfig* config=NULL)
  341.  
  342.           ilStatus setTile(int x, int y, int nx, int ny, const void* data,
  343.                            const ilConfig* config=NULL)
  344.           ilStatus getSubTile(int x, int y, int nx, int ny, void* data,
  345.                               int dx, int dy, int dnx, int dny,
  346.                               const ilConfig* config=NULL)
  347.  
  348.           ilStatus setSubTile(int x, int y, int nx, int ny, const void* data,
  349.                               int dx, int dy, int dnx, int dny,
  350.                               const ilConfig* config=NULL)
  351.  
  352.           ilStatus copyTile(int x, int y, int nx, int ny, ilImage* other,
  353.                             int ox, int oy, int* chanList=NULL)
  354.  
  355.           ilStatus fillTile(int x, int y, int nx, int ny, const void* data,
  356.                             const ilConfig* config=NULL, const iflTile2Dint* fillMask=NULL)
  357.  
  358.           ilStatus getPixel(int x, int y, iflPixel& pix)
  359.  
  360.           ilStatus setPixel(int x, int y, iflPixel& pix)
  361.  
  362.  
  363.  
  364.      DDDDaaaattttaaaa aaaacccccccceeeessssssss ssssuuuuppppppppoooorrrrtttt
  365.  
  366.           ilStatus clipTile(int &x, int &y, int &z, int &nx, int &ny, int &nz,
  367.                             int includeBorder=FALSE)
  368.  
  369.           ilStatus clipTile(iflTile3Dint& t, int includeBorder=FALSE)
  370.           ilStatus clipTile(float &x, float &y, float &z,
  371.                                   float &nx, float &ny,
  372.                                   float &nz, int includeBorder=FALSE)
  373.           ilStatus clipTile(iflTile3Dfloat& t, int includeBorder=FALSE)
  374.           ilStatus configureRetainedCache(const iflTile3Dint& tile,
  375.                                           int c = 0, int nc = -1,
  376.                                           int* chans = NULL, float minCacheBudget = .05,
  377.                                           float maxCacheBudget = 1,
  378.                                           size_t* retainedFileSize = NULL)
  379.           ilImageTile* getInputTileRequirement(const iflTile3Dint& tile,
  380.                                                int c, int nc,
  381.                                                int* chans, int& pageSetCount)
  382.           void setTileRequirementFunction(ilTileRequirementFuncPtr func)   _p_r_o_t_e_c_t_e_d
  383.           void getStrides(int& xs, int& ys, int& zs, int& cs, int nx=0,
  384.                                 int ny=0, int nz=0, int nc=0, iflOrder ord=iflOrder(0))
  385.  
  386.           int outOfBound(int x, int y)                              _p_r_o_t_e_c_t_e_d
  387.  
  388.           int outOfBound(int x, int y, int z)                       _p_r_o_t_e_c_t_e_d
  389.  
  390.  
  391.  
  392.                                                                         PPPPaaaaggggeeee 6666
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  400.  
  401.  
  402.  
  403.      QQQQuuuueeeerrrryyyyiiiinnnngggg aaaabbbboooouuuutttt iiiimmmmaaaaggggeeee pppprrrrooooppppeeeerrrrttttiiiieeeessss
  404.  
  405.           void getDimensions(iflSize& size)
  406.           int getXsize()
  407.           int getYsize()
  408.           int getZsize()
  409.           int getCsize()
  410.           int getNumChans()
  411.           int getWidth()
  412.           int getHeight()
  413.           void getSize(iflSize& size)
  414.           const iflSize& getSize()                _p_r_o_t_e_c_t_e_d
  415.           iflDataType getDataType()
  416.           iflOrder getOrder()
  417.           iflOrientation getOrientation()
  418.           void getConfig(ilConfig* cfg)
  419.           iflColorModel getColorModel()
  420.           iflCompression getCompression()
  421.           const iflPixel& pixel getFill()
  422.           const void* getFillData()
  423.           double getFillValue(int c=0)
  424.           ilStatus getColormap(iflColormap& cmap)
  425.           const iflColormap* getColormap()
  426.           int getMaxColormapLevels()
  427.           size_t getPageSize()
  428.           size_t getPageSize(int& nx, int& ny)
  429.           size_t getPageSize(int& nx, int& ny, int& nz, int& nc)
  430.           size_t getPageSize(iflSize& pageSize)
  431.           size_t getPageSize(iflSize& pageSize, iflOrientation ori)
  432.           size_t getPageDimensions()
  433.           int getPageSizeX()
  434.           int getPageSizeY()
  435.           int getPageSizeZ()
  436.           int getPageSizeC()
  437.           int getPageSizePix()
  438.           int getPageSizeVal()
  439.           int isPartialPage(int x, int y, int z, int c)          _p_r_o_t_e_c_t_e_d
  440.           int isValidPage(int x, int y, int z, int c)       _p_r_o_t_e_c_t_e_d
  441.           virtual int hasPages()
  442.           void getPageDelta(int& nx, int& ny, int& nz, int& nc)
  443.           void getPageDelta(iflXYZCint& delta)
  444.           void getPageBorder(iflXYZint& border)
  445.           const iflXYZint& getPageBorder()
  446.           int getPageBorderX()
  447.           int getPageBorderY()
  448.           int getPageBorderZ()
  449.           void getPageCounts(int& nx, int& ny, int& nz, int& nc)
  450.           void getPageIndices(int x, int y, int z, int c, int& ix,
  451.                               int& iy, int& iz, int& ic)
  452.           ilStatus getPageOrigin(int x, int y, int z, int c,
  453.                                        int& px, int& py, int& pz, int& pc)
  454.           ilStatus getPageOrigin(const iflXYZCint& pos, iflXYZCint& org)
  455.  
  456.  
  457.  
  458.                                                                         PPPPaaaaggggeeee 7777
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  466.  
  467.  
  468.  
  469.           int getPageOriginX(int x)
  470.           int getPageOriginY(int y)
  471.           int getPageOriginZ(int z)
  472.           int getPageOriginC(int c)
  473.           int getPriority()
  474.           int hasPageBorder()
  475.           int isIntegral()
  476.           int isSigned()
  477.           int isWritable()
  478.  
  479.  
  480.      SSSSeeeettttttttiiiinnnngggg iiiimmmmaaaaggggeeee pppprrrrooooppppeeeerrrrttttiiiieeeessss
  481.  
  482.           ilStatus setColorModel(iflColorModel c)
  483.           void initColorModel(int noAlpha=FALSE)                    _p_r_o_t_e_c_t_e_d
  484.           ilStatus setOrientation(iflOrientation spc)
  485.           ilStatus setDataType(iflDataType dtype)
  486.           ilStatus setCompression(iflCompression c)
  487.           ilStatus setFill(const iflPixel& pixel)
  488.           ilStatus setFillValue(double val, int c=0)
  489.           ilStatus setFillRGB(float red, float green, float blue)
  490.           ilStatus setSize(const iflSize& size)
  491.           ilStatus setSize(int nx, int ny)
  492.           ilStatus setXsize(int nx)
  493.           ilStatus setYsize(int ny)
  494.           ilStatus setZsize(int nc)
  495.           ilStatus setCsize(int nc)
  496.           ilStatus setNumChans(int nc)
  497.           ilStatus setOrder(iflOrder order)
  498.           void initPageSize(const iflSize& pageSize)           _p_r_o_t_e_c_t_e_d
  499.           ilStatus setPageSize(const iflSize& pageSize)
  500.           ilStatus setPageSize(int nx, int ny, int nz, int nc)
  501.           ilStatus setPageSize(int nx, int ny)
  502.           ilStatus setPageSizeZ(int nz)
  503.           ilStatus setPageSizeC(int nc)
  504.           ilStatus setPageBorder(const iflXYZint& border)
  505.           ilStatus setPageBorder(int nx, int ny, int nz=0)
  506.           ilStatus setColormap(const iflColormap& cmap)
  507.           void setMaxColormapLevels(int maxLevels)
  508.           void setPriority(int pri)
  509.           void setWritable(int enable=TRUE)                 _p_r_o_t_e_c_t_e_d
  510.           int inherit(int typeMask=0, int orderMask=0, int allowDiffColorModels=FALSE)_p_r_o_t_e_c_t_e_d
  511.           void checkValidType(int typeMask, int wantSigned=FALSE)     _p_r_o_t_e_c_t_e_d
  512.           void checkValidOrder(int orderMask)     _p_r_o_t_e_c_t_e_d
  513.  
  514.  
  515.      QQQQuuuueeeerrrryyyyiiiinnnngggg aaaabbbboooouuuutttt mmmmiiiinnnniiiimmmmuuuummmm aaaannnndddd mmmmaaaaxxxxiiiimmmmuuuummmm ppppiiiixxxxeeeellll
  516.  
  517.           double getMinValue()
  518.           double getMaxValue()
  519.  
  520.  
  521.  
  522.  
  523.  
  524.                                                                         PPPPaaaaggggeeee 8888
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  532.  
  533.  
  534.  
  535.      SSSSeeeettttttttiiiinnnngggg mmmmiiiinnnniiiimmmmuuuummmm aaaannnndddd mmmmaaaaxxxxiiiimmmmuuuummmm ppppiiiixxxxeeeellll vvvvaaaalllluuuueeeessss
  536.  
  537.           void initMinMax(int force=FALSE)                          _p_r_o_t_e_c_t_e_d
  538.           ilStatus setMinValue(double val)
  539.           ilStatus setMaxValue(double val)
  540.  
  541.  
  542.      MMMMaaaannnnaaaaggggiiiinnnngggg tttthhhheeee IIIImmmmaaaaggggeeee''''ssss ssssttttaaaatttteeee
  543.  
  544.           virtual void reset()                                       _p_r_o_t_e_c_t_e_d
  545.  
  546.           ilLockedTile* lockTile3D(int x, int y, int z,
  547.                          int nx, int ny, int nz,
  548.                               const ilConfig* config=NULL,
  549.                          int mode=ilLMread)
  550.           ilLockedTile* lockTile(int x, int y, int nx, int ny,
  551.                          const ilConfig* config=NULL, int mode=ilLMread)
  552.           ilStatus lockPageSet(ilLockRequest* set, int mode=ilLMread,
  553.                         int count=1)
  554.           virtual ilStatus qLockPageSet(ilMpNode* parent, ilLockRequest* set,
  555.                                         int mode=ilLMread, int count=1,
  556.                                         ilMpManager** pMgr=NULL,
  557.                                         ilCallback* perPageCb=NULL)
  558.           virtual void unlockPageSet(ilLockRequest* set, int count=1)
  559.           ilPage* lockPage(int x, int y, int z, int c, ilStatus& status,
  560.                                    int mode=ilLMread)
  561.           void unlockPage(ilPage* page)
  562.           ilLockRequest* getLockTileSet(int& count, const iflTile3Dint& tile,
  563.                                         const ilConfig* config=NULL,
  564.                                         int includeBorder=FALSE)
  565.  
  566.  
  567.      OOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn ssssuuuuppppppppoooorrrrtttt
  568.  
  569.           void mapTile(iflOrientation fromOri, iflTile2Dint& tile,
  570.                        iflOrientation workOri=iflOrientation(0))
  571.           void mapTile(iflOrientation fromOri, iflTile2Dfloat& tile,
  572.                        iflOrientation workOri=iflOrientation(0))
  573.           void mapTile(iflOrientation fromOri, iflTile2Dint &tile, iflFlip &flip,
  574.                        int &transXY, iflOrientation workOri=iflOrientation(0))
  575.           void mapXY(iflOrientation fromOri, int& x, int& y,
  576.                      iflOrientation workOri=iflOrientation(0))
  577.           void mapXY(iflOrientation fromOri, float& x, float& y,
  578.                      iflOrientation workOri=iflOrientation(0))
  579.           void mapXYSign(iflOrientation fromOri, float& x, float& y,
  580.                      iflOrientation workOri=iflOrientation(0))
  581.           void mapSize(iflOrientation fromOri, int& x, int& y,
  582.                      iflOrientation workOri=iflOrientation(0))
  583.           iflOrientation mapOrientation(int flipX, int flipY, int transXY=FALSE)
  584.           iflOrientation mapFlipTrans(iflOrientation fromOrientation,
  585.                              iflFlip& flip, int& transXY,
  586.                              iflOrientation workOrientation=iflOrientation(0));
  587.  
  588.  
  589.  
  590.                                                                         PPPPaaaaggggeeee 9999
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  598.  
  599.  
  600.  
  601.           void getSize(iflSize& size, iflOrientation workOri)
  602.           int isMirrorOrientation(iflOrientation otherOri,
  603.                                    iflOrientation workOri=iflOrientation(0))
  604.  
  605.  
  606.      MMMMaaaappppppppiiiinnnngggg ttttoooo oooorrrr ffffrrrroooommmm ssssoooouuuurrrrcccceeee iiiimmmmaaaaggggeeee
  607.  
  608.           ilStatus mapToSource(float& x, float& y, float& z,
  609.               float u, float v, float w)
  610.           ilStatus mapToSource(float& x, float& y, float u, float v)
  611.           ilStatus mapToSource(iflXYfloat& src, const iflXYfloat& self)
  612.           ilStatus mapFromSource(float& u, float& v, float& w,
  613.               float x, float y, float z)
  614.           ilStatus mapFromSource(float& u, float& v, float x, float y)
  615.           ilStatus mapFromSource(iflXYfloat& self, const iflXYfloat& src)
  616.           virtual ilStatus mapToInput(float& x, float& y, float& z,
  617.               float u, float v, float w, int idx=0)
  618.           ilStatus mapToInput(float& x, float& y, float u, float v, int idx=0)
  619.           ilStatus mapToInput(iflXYfloat& xy, const iflXYfloat& uv, int idx=0)
  620.           ilStatus void mapFromInput(float& u, float& v, float& w,
  621.               float x, float y, float z, int idx=0)
  622.           ilStatus mapFromInput(float& u, float& v, float x, float y, int idx=0)
  623.           ilStatus mapFromInput(iflXYfloat& uv, const iflXYfloat& xy, int idx=0)
  624.  
  625.  
  626.      CCCCoooolllloooorrrr ccccoooonnnnvvvveeeerrrrssssiiiioooonnnn ssssuuuuppppppppoooorrrrtttt
  627.  
  628.           ilColorImg* getColorImg(iflColorModel cm)
  629.           int isColorImg()
  630.           int getCopyConverter(ilImage*& other, const ilConfig* cfg) _p_r_o_t_e_c_t_e_d
  631.           void checkColorModel()                        _p_r_o_t_e_c_t_e_d
  632.           double getScaleMin()
  633.           double getScaleMax()
  634.           ilStatus setScaleMinMax(double min, double max)
  635.           ilStatus setScaleType(iflDataType type=iflDataType(0))
  636.           void initScaleMinMax(int force=FALSE)
  637.  
  638.  
  639.      HHHHaaaarrrrddddwwwwaaaarrrreeee AAAAcccccccceeeelllleeeerrrraaaattttiiiioooonnnn
  640.  
  641.           void setHwEnable(ilHwAccelEnable enable)
  642.           ilHwAccelEnable getHwEnable()
  643.           virtual ilHwOp* hwDefine()                   _p_r_o_t_e_c_t_e_d
  644.           virtual ilHwPass* hwGetPass(const ilHwTarget& target, int force=FALSE)
  645.           ilHwPassTable* getHwPassTable()                   _p_r_o_t_e_c_t_e_d
  646.           ilHwOp* getHwOp()                            _p_r_o_t_e_c_t_e_d
  647.           void setDisplayCacheEnable(int en=TRUE)           _p_r_o_t_e_c_t_e_d
  648.           int getDisplayCacheEnable()
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.                                                                        PPPPaaaaggggeeee 11110000
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  664.  
  665.  
  666.  
  667.      MMMMiiiisssscccceeeellllllllaaaannnneeeeoooouuuussss
  668.  
  669.           void* allocFillData(float red, float green, float blue)
  670.           void freeFillData(void* data)
  671.  
  672.  
  673. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  674.      iiiillllIIIImmmmaaaaggggeeee(((())))
  675.  
  676.           ilImage()
  677.           ilImage(iflSize &sz)
  678.  
  679.  
  680.           Two constructors are provided for ilImage. The default constructor
  681.           takes no parameters and is used by default for derived classes. The
  682.           second constructor takes a reference to an _i_f_l_S_i_z_e object, _s_z, which
  683.           is used to initialize the size of the image.
  684.  
  685.           An iflSize object contains integer members to hold the number of
  686.           pixels in the _x, _y and _z dimensions as well as the number of
  687.           channels per pixel _c (see also sssseeeettttSSSSiiiizzzzeeee()).  Both constructors
  688.           initialize most image attributes to 0 or NULL.  The ilLink altered
  689.           flag is set to _i_l_I_P_g_e_n_e_r_i_c and the ilLink allowed flag is set to
  690.           (_i_l_I_P_g_e_n_e_r_i_c|_i_l_I_P_m_i_n_P_i_x_e_l|_i_l_I_P_m_a_x_P_i_x_e_l|_i_l_I_P_f_i_l_l) (see the ilLink man
  691.           page and the enumerated type _i_l_I_m_g_P_a_r_a_m in _i_l/_i_l_I_m_a_g_e_s._h).  No
  692.           compression is assumed.  Status is set to ilOKAY.
  693.  
  694.  
  695.      aaaallllllllooooccccFFFFiiiillllllllDDDDaaaattttaaaa(((())))
  696.  
  697.           void* allocFillData(float red, float green, float blue)
  698.  
  699.  
  700.           This function allocates a pixel and sets it to correspond to the
  701.           given _r_e_d, _g_r_e_e_n, and _b_l_u_e pixel components.  The returned value
  702.           points to the allocated pixel, which should be free'd with
  703.           ffffrrrreeeeeeeeFFFFiiiillllllllDDDDaaaattttaaaa().
  704.  
  705.      aaaaddddddddIIIInnnnppppuuuutttt(((())))
  706.  
  707.           ilStatus addInput(ilImage* inimg)
  708.  
  709.  
  710.           Adds the image pointed to by _i_n_i_m_g to the end of the input (parent)
  711.           list.  See sssseeeettttIIIInnnnppppuuuutttt().
  712.  
  713.      cccchhhheeeecccckkkkCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  714.  
  715.           void checkColorModel()                        _p_r_o_t_e_c_t_e_d
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.                                                                        PPPPaaaaggggeeee 11111111
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  730.  
  731.  
  732.  
  733.           Checks the current color model against the number of channels. If
  734.           there is a mismatch, the number of channels (size.c) is adjusted to
  735.           match the color model. However, if the number of channels has been
  736.           set, then status is set to ilBADCOLFMT.
  737.  
  738.      cccchhhheeeecccckkkkVVVVaaaalllliiiiddddOOOOrrrrddddeeeerrrr(((())))
  739.  
  740.           void checkValidOrder(int orderMask)     _p_r_o_t_e_c_t_e_d
  741.  
  742.  
  743.           Select a data order for this image that is one of the intersection
  744.           of the orders specified in _o_r_d_e_r_M_a_s_k and the allowed orders for this
  745.           image (see iiiillllLLLLiiiinnnnkkkk::::::::sssseeeettttAAAAlllllllloooowwwweeeedddd()).
  746.  
  747.      This method is called by iiiinnnnhhhheeeerrrriiiitttt() and should only be called within an
  748.      image's rrrreeeesssseeeetttt() method.
  749.  
  750.      cccchhhheeeecccckkkkVVVVaaaalllliiiiddddTTTTyyyyppppeeee(((())))
  751.  
  752.           void checkValidType(int typeMask, int wantSigned=FALSE)     _p_r_o_t_e_c_t_e_d
  753.  
  754.  
  755.           Select a data type for this image that is one of the intersection of
  756.           the types specified in _t_y_p_e_M_a_s_k and the allowed data types for this
  757.           image (see iiiillllLLLLiiiinnnnkkkk::::::::sssseeeettttAAAAlllllllloooowwwweeeedddd()).  If _w_a_n_t_S_i_g_n_e_d is _T_R_U_E, then a
  758.           signed data type is selected if one is allowed. (See
  759.           iiiiffffllllDDDDaaaattttaaaaCCCClllloooosssseeeessssttttTTTTyyyyppppeeee(((()))) for details on the selection process.)
  760.  
  761.      This method is called by iiiinnnnhhhheeeerrrriiiitttt() and should only be called within an
  762.      image's rrrreeeesssseeeetttt() method.
  763.  
  764.      cccclllliiiippppTTTTiiiilllleeee(((())))
  765.  
  766.           ilStatus clipTile(int &x, int &y, int &z, int &nx, int &ny, int &nz,
  767.                             int includeBorder=FALSE)
  768.           ilStatus clipTile(iflTile3Dint& t, int includeBorder=FALSE)
  769.           ilStatus clipTile(float &x, float &y, float &z,
  770.                             float &nx, float &ny,
  771.                             float &nz, int includeBorder=FALSE)
  772.           ilStatus clipTile(iflTile3Dfloat& t, int includeBorder=FALSE)
  773.  
  774.  
  775.           Clips the given tile parameters to the image bounds.  The tile
  776.           boundaries might be passed as parameters to ggggeeeettttTTTTiiiilllleeee3333DDDD() or
  777.           sssseeeettttTTTTiiiilllleeee3333DDDD(), for example.  The tile may be specified as six int
  778.           parameters, or as an iflTile3Dint.  Alternative versions allow the
  779.           parameters to be passed as float.  If _i_n_c_l_u_d_e_B_o_r_d_e_r is TRUE, then
  780.           the clip bounds are increased to include the size of the page
  781.           border, if any (see sssseeeettttPPPPaaaaggggeeeeBBBBoooorrrrddddeeeerrrr(((())))).  If any of the parameters
  782.           needed to be clipped to fit the image, this function returns
  783.           ilDATACLIPPED; otherwise, it returns ilOKAY.
  784.  
  785.  
  786.  
  787.  
  788.                                                                        PPPPaaaaggggeeee 11112222
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  796.  
  797.  
  798.  
  799.      ccccoooonnnnffffiiiigggguuuurrrreeeeRRRReeeettttaaaaiiiinnnneeeeddddCCCCaaaacccchhhheeee(((())))
  800.  
  801.           ilStatus configureRetainedCache(const iflTile3Dint& tile,
  802.                                           int c = 0, int nc = -1,
  803.                                           int* chans = NULL, float minCacheBudget = .05,
  804.                                           float maxCacheBudget = 1,
  805.                                           size_t* retainedFileSize = NULL)
  806.  
  807.  
  808.           Convenience method that calls iiiillllCCCCoooonnnnffffiiiigggguuuurrrreeeeRRRReeeettttaaaaiiiinnnneeeeddddCCCCaaaacccchhhheeee() with a
  809.           single iiiillllIIIImmmmaaaaggggeeeeTTTTiiiilllleeee that specifies the tile for this image denoted in
  810.           the arguments _t_i_l_e, _c, _n_c, and _c_h_a_n_s.  The remaining arguments are
  811.           passed directly to iiiillllCCCCoooonnnnffffiiiigggguuuurrrreeeeRRRReeeettttaaaaiiiinnnneeeeddddCCCCaaaacccchhhheeee().  The value returned
  812.           by iiiillllCCCCoooonnnnffffiiiigggguuuurrrreeeeRRRReeeettttaaaaiiiinnnneeeeddddCCCCaaaacccchhhheeee() is returned.
  813.  
  814.      ccccooooppppyyyy(((())))
  815.  
  816.           ilStatus copy(ilImage* from)
  817.  
  818.  
  819.           Copies data from the image specified by _f_r_o_m.  If the two images are
  820.           of different sizes, only the origin-aligned  intersecting portion is
  821.           copied.  See also ccccooooppppyyyyTTTTiiiilllleeee3333DDDD().
  822.  
  823.      ccccooooppppyyyyTTTTiiiilllleeee(((())))
  824.  
  825.           ilStatus copyTile(int x, int y, int nx, int ny, ilImage* other,
  826.                       int ox, int oy, int* chanList=NULL)
  827.           ilStatus copyTile3D(int x, int y, int z, int nx, int ny, int nz,
  828.                               ilImage* other, int ox, int oy, int oz,
  829.                               int* chanList=NULL)
  830.           ilStatus copyTileCfg(int x, int y, int z, int nx, int ny, int nz,
  831.                                ilImage* other, int ox, int oy, int oz,
  832.                                const ilConfig* config=NULL)
  833.  
  834.  
  835.           These functions queue a copyTile request with qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg() and
  836.           wait for it to complete.  The tile at _x, _y, _z of size _n_x, _n_y, _n_z is
  837.           copied to this image from _o_t_h_e_r image at _o_x, _o_y, _o_z.  The 2D
  838.           version, ccccooooppppyyyyTTTTiiiilllleeee() calls the corresponding 3D routine with _z set to
  839.           zero and _n_z and _o_z set to one.
  840.  
  841.           ccccooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg() takes an ilConfig argument, _c_o_n_f_i_g, which is used to
  842.           reconfigure the pixel data type, order, channels and orientation as
  843.           well as offsetting into the channel dimension.  The other two copy
  844.           routines accept a channel list, which is used to construct an
  845.           ilConfig object with all other taken from "this" image.  The channel
  846.           list in _c_o_n_f_i_g specifies a channel mapping between the "other" and
  847.           "this" image. The number of entries in the list should always match
  848.           the number of channels in "this" image. A -1  means no data is
  849.           written for that channel.
  850.  
  851.  
  852.  
  853.  
  854.                                                                        PPPPaaaaggggeeee 11113333
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  862.  
  863.  
  864.  
  865.           See also qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg() and ggggeeeettttCCCCoooonnnnffffiiiigggg().
  866.  
  867.      ffffiiiillllllllTTTTiiiilllleeee(((())))
  868.  
  869.           ilStatus fillTile(int x, int y, int nx, int ny, const void* data,
  870.                       const ilConfig* config=NULL,
  871.                       const iflTile2Dint* fillMask=NULL)
  872.           ilStatus fillTile3D(int x, int y, int z, int nx, int ny, int nz,
  873.                               const void* data, const ilConfig* config=NULL,
  874.                               const iflTile2Dint* fillMask=NULL)
  875.           ilStatus fillTileRGB(int x, int y, int z, int nx, int ny, int nz,
  876.                          float red, float green, float blue,
  877.                          const iflTile3Dint* fillMask=NULL,
  878.                          iflOrientation orientation=iflOrientation(0));
  879.  
  880.  
  881.           These functions queue a fill tile request with qqqqFFFFiiiillllllllTTTTiiiilllleeee3333DDDD() or
  882.           qqqqFFFFiiiillllllllTTTTiiiilllleeeeRRRRGGGGBBBB() and wait for it to complete.  The tile at position
  883.           (_x,_y,_z) of size _n_x, _n_y, _n_z will be filled with a constant pixel
  884.           value.  ffffiiiillllllllTTTTiiiilllleeee() sets _z to zero and _n_z to one.
  885.  
  886.           _c_o_n_f_i_g describes the configuration (See the ilConfig man page) of
  887.           the fill value _d_a_t_a; if NULL, it is assumed to have the same
  888.           configuration as the image.  For example, to fill a tile of an RGB
  889.           image with white, _d_a_t_a should hold the values (255, 255, 255).
  890.           ffffiiiillllllllTTTTiiiilllleeeeRRRRGGGGBBBB() is provided as a convenience method for RGB images;
  891.           the _r_e_d, _g_r_e_e_n, and _b_l_u_e pixel components are passed directly as
  892.           floats.
  893.  
  894.           The parameter, _f_i_l_l_M_a_s_k, can be used to prevent filling a portion of
  895.           the tile.  If _f_i_l_l_M_a_s_k is not NULL, only the portion outside of
  896.           _f_i_l_l_M_a_s_k is filled. If _c_o_n_f_i_g is not NULL and it specifies a valid
  897.           orientation, then _f_i_l_l_M_a_s_k is mapped from that orientation to that
  898.           of the image; otherwise _f_i_l_l_M_a_s_k is assumed to have the same
  899.           orientation as that of the image.  ffffiiiillllllllTTTTiiiilllleeeeRRRRGGGGBBBB() takes a mask
  900.           _o_r_i_e_n_t_a_t_i_o_n as a parameter which defaults to the same orientation as
  901.           the image.
  902.  
  903.           See also the ilCacheImg man page.
  904.  
  905.      ffffrrrreeeeeeeeFFFFiiiillllllllDDDDaaaattttaaaa(((())))
  906.  
  907.           void freeFillData(void* data)
  908.  
  909.  
  910.           This function free's a pixel allocated with aaaallllllllooooccccFFFFiiiillllllllDDDDaaaattttaaaa().
  911.  
  912.      ggggeeeettttDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss(((())))
  913.  
  914.           void getDimensions(iflSize& size)
  915.  
  916.  
  917.  
  918.  
  919.  
  920.                                                                        PPPPaaaaggggeeee 11114444
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  928.  
  929.  
  930.  
  931.           Returns the size of the image in the ilLowerLeftOrigin orientation.
  932.  
  933.      ggggeeeettttDDDDiiiirrrreeeeccccttttIIIInnnnppppuuuutttt(((())))
  934.  
  935.           ilImage* getDirectInput(int idx = 0)
  936.  
  937.  
  938.           Return the direct input at index _i_d_x, ignoring whether or not it is
  939.           enabled.  (See ggggeeeettttIIIInnnnppppuuuutttt() and iiiillllLLLLiiiinnnnkkkk::::::::ggggeeeettttDDDDiiiirrrreeeeccccttttPPPPaaaarrrreeeennnntttt().)
  940.  
  941.      ggggeeeettttDDDDiiiissssppppllllaaaayyyyCCCCaaaacccchhhheeeeEEEEnnnnaaaabbbblllleeee(((())))
  942.  
  943.           int getDisplayCacheEnable()
  944.  
  945.  
  946.           Returns the current setting for the display cache enable. See
  947.           sssseeeettttDDDDiiiissssppppllllaaaayyyyCCCCaaaacccchhhheeeeEEEEnnnnaaaabbbblllleeee.
  948.  
  949.      ggggeeeettttCCCCoooolllloooorrrrIIIImmmmgggg(((())))
  950.  
  951.           ilColorImg* getColorImg(iflColorModel cm)
  952.  
  953.  
  954.           Returns a pointer to an ilColorImg that is a child of "this" image
  955.           and has the color model specified by _c_m. The new color converter
  956.           inherits most attributes, except for the color model and the number
  957.           of channels, from "this" image.
  958.  
  959.      ggggeeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  960.  
  961.           ilStatus getColormap(iflColormap &cmap)
  962.           const iflColormap* getColormap()
  963.  
  964.  
  965.           These functions return the image's colormap.  The first version
  966.           deposits the image's color map in the iflColormap object pointed to
  967.           by _c_m_a_p and returns a status value.  The status value is either the
  968.           image's status or ilNULLOBJ, if the colormap is NULL.  If ilOKAY is
  969.           not returned, then the argument is unchanged.  The second version
  970.           returns a pointer to this image object's colormap, which may be
  971.           NULL.
  972.  
  973.  
  974.  
  975.  
  976.  
  977.  
  978.  
  979.  
  980.  
  981.  
  982.  
  983.  
  984.  
  985.  
  986.                                                                        PPPPaaaaggggeeee 11115555
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  994.  
  995.  
  996.  
  997.      ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  998.  
  999.           iflColorModel getColorModel()
  1000.  
  1001.  
  1002.           Returns the color model of the image. _i_f_l_C_o_l_o_r_M_o_d_e_l is an enumerated
  1003.           type with the following members:
  1005.           _i_f_l_R_G_B         red, green, blue
  1006.  
  1007.           _i_f_l_R_G_B_A        red, green, blue, alpha
  1008.  
  1009.           _i_f_l_R_G_B_P_a_l_e_t_t_e  RGB color mapped to a look-up  table
  1010.  
  1011.           _i_f_l_H_S_V         hue, saturation, value
  1012.  
  1013.           _i_f_l_C_M_Y         cyan, magenta, yellow
  1014.  
  1015.           _i_f_l_C_M_Y_K        cyan, magenta, yellow, black
  1016.  
  1017.           _i_f_l_N_e_g_a_t_i_v_e    inverted luminance (min is white, max is black)
  1018.  
  1019.           _i_f_l_L_u_m_i_n_a_n_c_e   luminance
  1020.  
  1021.           _i_f_l_L_u_m_i_n_a_n_c_e_A_l_p_h_a
  1022.                          luminance, alpha
  1023.  
  1024.           _i_f_l_B_G_R         swapped RGB, for images generated by SGI
  1025.  
  1026.           _i_f_l_A_B_G_R        swapped RGBA, for images generated by SGI
  1027.  
  1028.           _i_f_l_M_u_l_t_i_S_p_e_c_t_r_a_l
  1029.                          multiple channels of sensor-specific  data
  1031.           The color model is used to interpret the meaning of the channels
  1032.           that make up a pixel. See also sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll().
  1033.  
  1034.      ggggeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))
  1035.  
  1036.           iflCompression getCompression()
  1037.  
  1038.  
  1039.           Returns the image compression parameter as the enumerated type,
  1040.           _i_f_l_C_o_m_p_r_e_s_s_i_o_n.  This parameter reflects the type of compression
  1041.           used in the image data.  See also sssseeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn().
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.                                                                        PPPPaaaaggggeeee 11116666
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1059.  
  1060.  
  1061.  
  1062.      ggggeeeettttCCCCoooonnnnffffiiiigggg(((())))
  1063.  
  1064.           void getConfig(ilConfig* cfg)
  1065.  
  1066.  
  1067.           Returns the image's configuration in the ilConfig object pointed to
  1068.           by _c_f_g. The ilConfig class (see _i_l/_i_l_C_o_n_f_i_g._h) contains eight
  1069.           elements:  an iflDataType that defines the data type of the image's
  1070.           pixels, an iflOrder that describes how that data is ordered, an int
  1071.           that sets how many data channels there are, an array of ints that
  1072.           determines the order of the channels, an iflOrientation, and three
  1073.           zoom factors for the three dimensions.  See also ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(),
  1074.           ggggeeeettttOOOOrrrrddddeeeerrrr(), ggggeeeettttNNNNuuuummmmCCCChhhhaaaannnnssss() and ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn().
  1075.  
  1076.      ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))
  1077.  
  1078.           iflOrientation getOrientation()
  1079.  
  1080.  
  1081.           Returns the image orientation parameter as the enumerated type,
  1082.           _i_f_l_O_r_i_e_n_t_a_t_i_o_n. This parameter determines, for example, whether the
  1083.           image origin is the upper left corner or the lower left corner.  See
  1084.           also sssseeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn().
  1085.  
  1086.      ggggeeeettttCCCCooooppppyyyyCCCCoooonnnnvvvveeeerrrrtttteeeerrrr(((())))
  1087.  
  1088.           int getCopyConverter(ilImage*& other, const ilConfig* cfg)    _p_r_o_t_e_c_t_e_d
  1089.  
  1090.  
  1091.           If the _o_t_h_e_r image has a different color model than this image, a
  1092.           color converter operator is chained onto _o_t_h_e_r and TRUE is returned
  1093.           (the new operator is returned via _o_t_h_e_r).  If the color models are
  1094.           compatible, OR if the _c_f_g specifies a channel list or channel
  1095.           offset, then no operator is chained and FALSE is returned.  When _c_f_g
  1096.           specifies a channel list or offset, it is assumed that no color
  1097.           conversion should be performed.
  1098.  
  1099.      ggggeeeettttCCCCssssiiiizzzzeeee(((())))
  1100.  
  1101.           int getCsize()
  1102.           int getNumChans()
  1103.  
  1104.  
  1105.           Returns the number of channels in the image. For example an RGB
  1106.           image is a 3 channel image.
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.                                                                        PPPPaaaaggggeeee 11117777
  1118.  
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1125.  
  1126.  
  1127.  
  1128.      ggggeeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))
  1129.  
  1130.           iflDataType getDataType()
  1131.  
  1132.  
  1133.           Returns the data type of the image's pixels.  The iflDataType value
  1134.           returned can be one of the following: _i_f_l_B_i_t, _i_f_l_C_h_a_r, _i_f_l_U_C_h_a_r,
  1135.           _i_f_l_S_h_o_r_t, _i_f_l_U_S_h_o_r_t, _i_f_l_L_o_n_g, _i_f_l_U_L_o_n_g, _i_f_l_F_l_o_a_t, or _i_f_l_D_o_u_b_l_e.  See
  1136.           also ggggeeeettttCCCCoooonnnnffffiiiigggg().
  1137.  
  1138.      ggggeeeettttFFFFiiiillllllll(((())))
  1139.  
  1140.           const iflPixel& pixel getFill()
  1141.  
  1142.  
  1143.           Returns a reference to the image's fill pixel value. See also
  1144.           sssseeeettttFFFFiiiillllllll().
  1145.  
  1146.      ggggeeeettttFFFFiiiillllllllDDDDaaaattttaaaa(((())))
  1147.  
  1148.           const void* getFillData()
  1149.  
  1150.  
  1151.           This function calls the ggggeeeettttDDDDaaaattttaaaa() method of the image's fill pixel
  1152.           and returns the result.
  1153.  
  1154.      ggggeeeettttFFFFiiiillllllllVVVVaaaalllluuuueeee(((())))
  1155.  
  1156.           double getFillValue(int c=0)
  1157.  
  1158.  
  1159.           Returns the image fill value of channel _c.  See also ggggeeeettttFFFFiiiillllllll().
  1160.  
  1161.      ggggeeeettttHHHHeeeeiiiigggghhhhtttt(((())))
  1162.  
  1163.           int getHeight()
  1164.  
  1165.  
  1166.           Returns the height of _i_m_g.  See also getWidth() and getYsize().
  1167.  
  1168.      ggggeeeettttHHHHwwwwEEEEnnnnaaaabbbblllleeee(((())))
  1169.  
  1170.           ilHwAccelEnable getHwEnable()
  1171.  
  1172.  
  1173.           This function returns the value of the hardware acceleration enable
  1174.           flag as set by sssseeeettttHHHHwwwwEEEEnnnnaaaabbbblllleeee().
  1175.  
  1176.      ggggeeeettttHHHHwwwwOOOOpppp(((())))
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.                                                                        PPPPaaaaggggeeee 11118888
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1191.  
  1192.  
  1193.  
  1194.           ilHwOp *getHwOp()                       _p_r_o_t_e_c_t_e_d
  1195.  
  1196.  
  1197.           This function returns a pointer to the ilHwOp private member
  1198.           variable; it is provided to allow access by derived classes.
  1199.  
  1200.           Currently, user-defined hardware acceleration is unsupported.  For
  1201.           more information on hardware acceleration, see ilHwDefs.h and the
  1202.           Programmer's Guide.
  1203.  
  1204.      ggggeeeettttHHHHwwwwPPPPaaaassssssssTTTTaaaabbbblllleeee(((())))
  1205.  
  1206.           ilHwPassTable* getHwPassTable()              _p_r_o_t_e_c_t_e_d
  1207.  
  1208.  
  1209.           This function returns a pointer to the ilHwPassTable for this image;
  1210.           it is provided to allow access to this table by derived classes.
  1211.  
  1212.           Currently, user-defined hardware acceleration is unsupported.  For
  1213.           more information on hardware acceleration, see ilHwDefs.h and the
  1214.           Programmer's Guide.
  1215.  
  1216.      ggggeeeettttIIIInnnnppppuuuutttt(((())))
  1217.  
  1218.           ilImage* getInput(int idx = 0)
  1219.  
  1220.  
  1221.           Returns a pointer to the ilImage at index _i_d_x in the parent list.
  1222.           NULL is returned if there is no image at the specified index.  The
  1223.           default index is 0.
  1224.  
  1225.      ggggeeeettttIIIInnnnppppuuuuttttTTTTiiiilllleeeeRRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnntttt(((())))
  1226.  
  1227.           ilImageTile* getInputTileRequirement(const iflTile3Dint& tile,
  1228.                                                int c, int nc,
  1229.                                                int* chans, int& pageSetCount)
  1230.  
  1231.  
  1232.           This method is used by the global function
  1233.           iiiillllCCCCoooonnnnffffiiiigggguuuurrrreeeeRRRReeeettttaaaaiiiinnnneeeeddddCCCCaaaacccchhhheeee() to determine the input data requirement
  1234.           to evaluate a given output tile.  The method really ought to be a
  1235.           virtual, so that derived classes can easily override its behavior,
  1236.           but it cannot be done this way and still maintain binary
  1237.           compatibility with IL 3.1.1.  Therefore, a derived class can
  1238.           override the behavior of this method only by calling the method
  1239.           sssseeeettttTTTTiiiilllleeeeRRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttFFFFuuuunnnnccccttttiiiioooonnnn() to establish a new behavior.
  1240.  
  1241.           The default implementation returns an array of iiiillllIIIImmmmaaaaggggeeeeTTTTiiiilllleeee's, one
  1242.           for each of the image's inputs, with tile coordinates identical to
  1243.           the passed tile coordinates.  Derived classes, such as iiiillllMMMMoooonnnnaaaaddddiiiiccccIIIImmmmgggg
  1244.           and iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg, override the default behavior to take input
  1245.           offsets into account.  iiiillllWWWWaaaarrrrppppIIIImmmmgggg overrides the default behavior to
  1246.  
  1247.  
  1248.  
  1249.                                                                        PPPPaaaaggggeeee 11119999
  1250.  
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1257.  
  1258.  
  1259.  
  1260.           incorporate the effect of the warp.  As an example of overriding the
  1261.           default behavior, here is iiiillllPPPPoooollllyyyyaaaaddddiiiiccccIIIImmmmgggg's version:
  1262.  
  1263.           ilImageTile*
  1264.           ilPolyadicImg::getInputTileRequirement(const iflTile& tile, int c, int nc,
  1265.                                      int* chans, int& inputTileCount)
  1266.           {
  1267.               if (resetCheck()) { inputTileCount = 0; return NULL; }
  1268.  
  1269.               int count = getNumParents();
  1270.               ilImageTile* inputTiles = new ilImageTile [count];
  1271.  
  1272.               int activeCount = 0;
  1273.               ilLinkParentIter iter(this);
  1274.               ilLink* link;
  1275.               while (link = iter.next()) {
  1276.                if (link->derivesFrom(iflClassID(ilImage))) {
  1277.                    ilImage* img = (ilImage*)link;
  1278.                    iflTile offTile = tile;
  1279.                    int idx = iter.currIndex();
  1280.                    if (idx >= 0) {
  1281.                     int x, y, z;
  1282.                     getOffset(x, y, z, idx);
  1283.                     offTile.x -= x;
  1284.                     offTile.y -= y;
  1285.                     offTile.z -= z;
  1286.                    }
  1287.                    inputTiles[activeCount++].init(img, offTile, c, nc, chans);
  1288.                }
  1289.                else if (link->derivesFrom(iflClassID(ilImgStat)))
  1290.                    activeCount += ((ilImgStat*)link)
  1291.                             ->getInputTileRequirement(inputTiles[activeCount]);
  1292.               }
  1293.  
  1294.               inputTileCount = activeCount;
  1295.               if (activeCount == 0) { delete inputTiles; inputTiles = NULL; }
  1296.  
  1297.               return inputTiles;
  1298.           }
  1299.  
  1300.  
  1301.      ggggeeeettttLLLLoooocccckkkkTTTTiiiilllleeeeSSSSeeeetttt(((())))
  1302.  
  1303.           ilLockRequest* getLockTileSet(int& count, const iflTile3Dint& tile,
  1304.                                         const ilConfig* config=NULL,
  1305.                                         int includeBorder=FALSE)
  1306.  
  1307.  
  1308.           This function generates an array of ilLockRequests corresponding to
  1309.           the specified "tile" in the image.  These requests can then be
  1310.           passed to lllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() and uuuunnnnlllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() to lock the pages
  1311.           comprising the tile.  If _i_n_c_l_u_d_e_B_o_r_d_e_r is TRUE then all pages that
  1312.  
  1313.  
  1314.  
  1315.                                                                        PPPPaaaaggggeeee 22220000
  1316.  
  1317.  
  1318.  
  1319.  
  1320.  
  1321.  
  1322. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1323.  
  1324.  
  1325.  
  1326.           intersect the tile comprise the set.  Otherwise, the smallest set of
  1327.           pages that cover the tile comprises the set.  This distinction is
  1328.           relevant only if the image has non-zero page borders.  Generally,
  1329.           you should set _i_n_c_l_u_d_e_B_o_r_d_e_r to TRUE if you are generating the set
  1330.           for writing, and FALSE if you are generating the set for reading.
  1331.           The number of generated lock requests is returned in the reference
  1332.           parameter "count".  The returned ilLockRequest set is in nnnneeeewwww()'ed
  1333.           memory.  It is the responsibility of the caller to delete the set
  1334.           when no longer in use.
  1335.  
  1336.      ggggeeeettttMMMMaaaaxxxxCCCCoooolllloooorrrrmmmmaaaappppLLLLeeeevvvveeeellllssss(((())))
  1337.  
  1338.           int getMaxColormapLevels()
  1339.  
  1340.  
  1341.           This function returns the maximum color map level attribute set with
  1342.           sssseeeettttMMMMaaaaxxxxCCCCoooolllloooorrrrmmmmaaaappppLLLLeeeevvvveeeellllssss().
  1343.  
  1344.      ggggeeeettttMMMMaaaaxxxxVVVVaaaalllluuuueeee(((())))
  1345.  
  1346.           double getMaxValue()
  1347.  
  1348.  
  1349.           Returns the maximum allowable value for this image object.
  1350.  
  1351.      ggggeeeettttMMMMiiiinnnnVVVVaaaalllluuuueeee(((())))
  1352.  
  1353.           double getMinValue()
  1354.  
  1355.  
  1356.           Returns the minimum allowable value for this image object.
  1357.  
  1358.      ggggeeeettttNNNNuuuummmmIIIInnnnppppuuuuttttssss(((())))
  1359.  
  1360.           int getNumInputs()
  1361.  
  1362.  
  1363.           Returns the number of images in this image's input (parent) list.
  1364.  
  1365.      ggggeeeettttOOOOrrrrddddeeeerrrr(((())))
  1366.  
  1367.           iflOrder getOrder()
  1368.  
  1369.  
  1370.           Returns the pixel channel order of this image. The enumerated type,
  1371.           _i_f_l_O_r_d_e_r, has members _i_f_l_I_n_t_e_r_l_e_a_v_e_d, _i_f_l_S_e_q_u_e_n_t_i_a_l, or _i_f_l_S_e_p_a_r_a_t_e
  1372.           to indicate how the pixel data is ordered.
  1373.  
  1374.           For _i_f_l_I_n_t_e_r_l_e_a_v_e_d, all pixel channels are stored adjacently.  For
  1375.           an RGB color image, this would be RGBRGBRGB, and so forth.  For
  1376.           _i_f_l_S_e_q_u_e_n_t_i_a_l, each pixel channel is stored as a separate line.  For
  1377.           an RGB color image, this is a line of Red, followed by a line of
  1378.  
  1379.  
  1380.  
  1381.                                                                        PPPPaaaaggggeeee 22221111
  1382.  
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1389.  
  1390.  
  1391.  
  1392.           Green, followed by a line of Blue for one line of RGB pixels.  For
  1393.           _i_f_l_S_e_p_a_r_a_t_e, each channel is stored in a separate page.  See the
  1394.           _I_m_a_g_e_V_i_s_i_o_n _L_i_b_r_a_r_y _P_r_o_g_r_a_m_m_i_n_g _G_u_i_d_e for more details.
  1395.  
  1396.      ggggeeeettttPPPPaaaaggggeeeeBBBBoooorrrrddddeeeerrrr(((())))
  1397.  
  1398.           void getPageBorder(iflXYZint& border)
  1399.           const iflXYZint& getPageBorder()
  1400.           int getPageBorderX()
  1401.           int getPageBorderY()
  1402.           int getPageBorderZ()
  1403.  
  1404.  
  1405.           Returns the page border size in an iflXYZint structure.
  1406.  
  1407.           The alternative methods provide access to the per-coordinate page
  1408.           border values.
  1409.  
  1410.      ggggeeeettttPPPPaaaaggggeeeeCCCCoooouuuunnnnttttssss(((())))
  1411.  
  1412.           void getPageCounts(int& nx, int& ny, int& nz, int& nc)
  1413.  
  1414.  
  1415.           Returns the number of pages required to cover the entire image
  1416.           extent in each of the _x, _y, _z, and _c dimensions
  1417.  
  1418.      ggggeeeettttPPPPaaaaggggeeeeDDDDeeeellllttttaaaa(((())))
  1419.  
  1420.           void getPageDelta(iflXYZCint& delta)
  1421.           void getPageDelta(int &nx, int &ny, int &nz, int &nc)
  1422.  
  1423.  
  1424.           Returns the effective page size with page borders removed.  It is
  1425.           computed by subtracting twice the page border size from the current
  1426.           page size.
  1427.  
  1428.      ggggeeeettttPPPPaaaaggggeeeeIIIInnnnddddiiiicccceeeessss(((())))
  1429.  
  1430.           void getPageIndices(int x, int y, int z, int c, int& ix,
  1431.                               int& iy, int& iz, int& ic)
  1432.  
  1433.  
  1434.           Return the indices of the image page containing the point (_x, _y, _z,
  1435.           _c).
  1436.  
  1437.      ggggeeeettttPPPPaaaaggggeeeeOOOOrrrriiiiggggiiiinnnn(((())))
  1438.  
  1439.           ilStatus getPageOrigin(int x, int y, int z, int c,
  1440.                                  int& px, int& py, int& pz, int& pc)
  1441.           ilStatus getPageOrigin(const iflXYZCint& pos, iflXYZCint& org)
  1442.           int getPageOriginX(int x)
  1443.           int getPageOriginY(int y)
  1444.  
  1445.  
  1446.  
  1447.                                                                        PPPPaaaaggggeeee 22222222
  1448.  
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1455.  
  1456.  
  1457.  
  1458.           int getPageOriginZ(int z)
  1459.           int getPageOriginC(int c)
  1460.  
  1461.  
  1462.           This method returns the origin of the page that contains the point
  1463.           passed in as _x, _y, _z, and _c.  The coordinates of the page are
  1464.           returned in _p_x, _p_y, _p_c, and _p_z.  The returned page coordinates may
  1465.           correspond to a page that does not actually reside within the image
  1466.           bounds if the passed pixel coordinates are also outside the image
  1467.           bounds.  If the image has page borders, then it is possible that
  1468.           more than one page contains the point.  In this case, the page with
  1469.           the greatest coordinate values is returned.
  1470.  
  1471.           If the image's status is not ilOKAY, then that status is returned
  1472.           and the page coordinates values are not set.  Otherwise, ilOKAY is
  1473.           returned.
  1474.  
  1475.           Alternative methods are provided to compute each of the page
  1476.           coordinates independently.
  1477.  
  1478.      ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee(((())))
  1479.  
  1480.           size_t getPageSize()
  1481.           size_t getPageSize(int& nx, int& ny)
  1482.           size_t getPageSize(int& nx, int& ny, int& nz, int& nc)
  1483.           size_t getPageSize(iflSize& pageSize)
  1484.           size_t getPageSize(iflSize& pageSize, iflOrientation ori)
  1485.           size_t getPageDimensions(iflSize& pageSize)
  1486.  
  1487.  
  1488.           Returns the image page size in bytes. This takes into account the
  1489.           number of channels per pixel and the channel data type.  The second
  1490.           and third versions also return the page size in the x, y, z, c
  1491.           dimensions in _n_x, _n_y, _n_z and _n_c.  The fourth version returns the
  1492.           page size in an iflSize structure, possibly transformed into the
  1493.           orientation specified in _o_r_i. The x and y page size will be
  1494.           transposed as needed, based on the orientation. See also the
  1495.           ilCacheImg man page.
  1496.  
  1497.           The ggggeeeettttPPPPaaaaggggeeeeDDDDiiiimmmmeeeennnnssssiiiioooonnnnssss method returns the page size in a standard
  1498.           (non-transposed) orientation.  This is useful if you are interested
  1499.           in the "width" or "height" of a page, independent of the data
  1500.           orientation.
  1501.  
  1502.  
  1503.  
  1504.  
  1505.  
  1506.  
  1507.  
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.                                                                        PPPPaaaaggggeeee 22223333
  1514.  
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1521.  
  1522.  
  1523.  
  1524.      ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeeXXXX(((()))) ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeeYYYY(((()))) ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeeZZZZ(((()))) ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeeCCCC(((())))
  1525.  
  1526.           int getPageSizeX()
  1527.           int getPageSizeY()
  1528.           int getPageSizeZ()
  1529.           int getPageSizeC()
  1530.  
  1531.  
  1532.           Returns the image's page size in the _x-, _y-, _z-, _c-dimensions,
  1533.           respectively.
  1534.  
  1535.      ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeePPPPiiiixxxx(((())))
  1536.  
  1537.           int getPageSizePix()
  1538.  
  1539.  
  1540.           Returns the image page size in pixels.  See also ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee().
  1541.  
  1542.      ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeeVVVVaaaallll(((())))
  1543.  
  1544.           int getPageSizeVal()
  1545.  
  1546.  
  1547.           Returns the image page size in terms of discrete values. This takes
  1548.           into account the number of channels per pixel that is, it returns
  1549.           ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeeePPPPiiiixxxx() * number of channels in the page).  See also
  1550.           ggggeeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee().
  1551.  
  1552.      ggggeeeettttPPPPiiiixxxxeeeellll(((())))
  1553.  
  1554.           ilStatus getPixel(int x, int y, iflPixel& pix)
  1555.  
  1556.  
  1557.           This function is the 2-D version of ggggeeeettttPPPPiiiixxxxeeeellll3333DDDD().  It calls
  1558.           ggggeeeettttPPPPiiiixxxxeeeellll3333DDDD() with _z set to 0.  See also ggggeeeettttPPPPiiiixxxxeeeellll3333DDDD().
  1559.  
  1560.      ggggeeeettttPPPPiiiixxxxeeeellll3333DDDD(((())))
  1561.  
  1562.           ilStatus getPixel3D(int x, int y, int z, iflPixel& pix)
  1563.  
  1564.  
  1565.           Gets the iflPixel at the point specified by _x, _y, and _z and returns
  1566.           it in _p_i_x.  An iflPixel specifies the channel data type, the number
  1567.           of channels per pixel and a pointer to the pixel data.  This
  1568.           function calls ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() with the tile size _n_x, _n_y, _n_z set to
  1569.           1. Returns ilOKAY upon successful completion.  See also ggggeeeettttPPPPiiiixxxxeeeellll(),
  1570.           ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and sssseeeettttPPPPiiiixxxxeeeellll3333DDDD().
  1571.  
  1572.  
  1573.  
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.                                                                        PPPPaaaaggggeeee 22224444
  1580.  
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1587.  
  1588.  
  1589.  
  1590.      ggggeeeettttPPPPrrrriiiioooorrrriiiittttyyyy(((())))
  1591.  
  1592.           int getPriority()
  1593.  
  1594.  
  1595.           This function gets the current cache priority of this image.  See
  1596.           sssseeeettttPPPPrrrriiiioooorrrriiiittttyyyy() for more details.
  1597.  
  1598.      ggggeeeettttSSSSccccaaaalllleeeeMMMMaaaaxxxx(((())))
  1599.  
  1600.           double getScaleMax()
  1601.  
  1602.  
  1603.           Returns the maximum value used for scaling during color conversion
  1604.           and display.  By default the maximum scale value tracks the maximum
  1605.           value of the image. However, it may be set with sssseeeettttSSSSccccaaaalllleeeeMMMMiiiinnnnMMMMaaaaxxxx().
  1606.  
  1607.      ggggeeeettttSSSSccccaaaalllleeeeMMMMiiiinnnn(((())))
  1608.  
  1609.           double getScaleMin()
  1610.  
  1611.  
  1612.           Returns the minimum value used for scaling during color conversion
  1613.           and display.  By default the minimum scale value tracks the minimum
  1614.           value of the image. However, it may be set with sssseeeettttSSSSccccaaaalllleeeeMMMMiiiinnnnMMMMaaaaxxxx().
  1615.  
  1616.      ggggeeeettttSSSSiiiizzzzeeee(((())))
  1617.  
  1618.           void getSize(iflSize& size)
  1619.           void getSize(iflSize& size, iflOrientation workOri)
  1620.           const iflSize& getSize()
  1621.  
  1622.  
  1623.           The first version returns the image size in the iflSize object
  1624.           referenced by _s_i_z_e.  An iflSize has integer member variables _x, _y,
  1625.           _z, and _c to hold each dimension of the image.  The second version
  1626.           first maps the image's size to the orientation indicated by _w_o_r_k_O_r_i.
  1627.           If the indicated orientation is transposed relative to the image's
  1628.           orientation, then the _x and _y sizes are swapped in the returned
  1629.           size.  See also ggggeeeettttXXXXSSSSiiiizzzzeeee(), ggggeeeettttYYYYSSSSiiiizzzzeeee(), ggggeeeettttZZZZSSSSiiiizzzzeeee() and ggggeeeettttCCCCSSSSiiiizzzzeeee().
  1630.           The third version returns a reference to the actual _s_i_z_e attribute
  1631.           of this image object.
  1632.  
  1633.      ggggeeeettttSSSSttttrrrriiiiddddeeeessss(((())))
  1634.  
  1635.           void getStrides(int& xs, int& ys, int& zs, int& cs,
  1636.                     int nx=0, int ny=0, int nz=0, int nc=0,
  1637.                      iflOrder ord=iflOrder(0))
  1638.  
  1639.  
  1640.  
  1641.  
  1642.  
  1643.  
  1644.  
  1645.                                                                        PPPPaaaaggggeeee 22225555
  1646.  
  1647.  
  1648.  
  1649.  
  1650.  
  1651.  
  1652. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1653.  
  1654.  
  1655.  
  1656.           Returns by reference the x stride (_x_s), y stride (_y_s), z stride
  1657.           (_z_s), channel stride (_c_s) and number of channels (_n_c). The buffer
  1658.           strides are used to step through a data buffer of size _n_x by _n_y that
  1659.           contains pixels with channel order _o_r_d.  The default order is
  1660.           _n_u_m_i_f_l_O_r_d_e_r_s and causes the current data order to be used.
  1661.  
  1662.           The x stride is used to step from one pixel to the next in the same
  1663.           row. The y stride is used to step to the next pixel in the same
  1664.           column. For 3D images, the z stride is used to step to the next
  1665.           pixel along the z axis at the same xy location. A multiplier _n can
  1666.           be used to move _n pixels in a desired direction within the data
  1667.           buffer.
  1668.  
  1669.           The channel stride is used to step to the next channel of the same
  1670.           pixel.
  1671.  
  1672.      ggggeeeettttTTTTiiiilllleeee(((())))
  1673.  
  1674.           ilStatus getTile(int x, int y, int nx, int ny,
  1675.                            void* data, const ilConfig* config=NULL)
  1676.           ilStatus getTile3D(int x, int y, int z, int nx, int ny, int nz,
  1677.                              void* data, const ilConfig* config=NULL)
  1678.           ilStatus getSubTile(int x, int y, int nx, int ny, void* data,
  1679.                         int dx, int dy, int dnx, int dny,
  1680.                         const ilConfig* config=NULL)
  1681.           ilStatus getSubTile3D(int x, int y, int z, int nx, int ny, int nz,
  1682.                                 void* data, int dx, int dy, int dz,
  1683.                           int dnx, int dny, int dnz,
  1684.                           const ilConfig* config=NULL)
  1685.  
  1686.  
  1687.           These functions queue a tile read request with qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and
  1688.           wait for it to complete.  The source tile origin is specified by _x,
  1689.           _y, _z, and the tile size is specified by _n_x, _n_y, _n_z.
  1690.  
  1691.           The 2D versions, ggggeeeettttTTTTiiiilllleeee() and ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee(), call the corresponding
  1692.           3D routine with _z set to zero and _n_z set to one.
  1693.  
  1694.           ggggeeeettttTTTTiiiilllleeee() and ggggeeeettttTTTTiiiilllleeee3333DDDD() assume that the destination buffer has the
  1695.           same offset and size as the request; ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee() and ggggeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD()
  1696.           allow the destination buffer to have a different position and size,
  1697.           specified by _d_x, _d_y, _d_n_x, and _d_n_y (and _d_z and _d_n_z for the 3D
  1698.           version.)
  1699.  
  1700.           Optionally, an ilConfig object pointed to by _c_o_n_f_i_g can be used to
  1701.           specify the desired data type, order, number of channels and channel
  1702.           order. _c_o_n_f_i_g is NULL by default, meaning that no conversion is
  1703.           performed on the input data.
  1704.  
  1705.           See also qqqqGGGGeeeettttTTTTiiiilllleeee3333DDDD(), qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and ggggeeeettttCCCCoooonnnnffffiiiigggg().
  1706.  
  1707.  
  1708.  
  1709.  
  1710.  
  1711.                                                                        PPPPaaaaggggeeee 22226666
  1712.  
  1713.  
  1714.  
  1715.  
  1716.  
  1717.  
  1718. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1719.  
  1720.  
  1721.  
  1722.      ggggeeeettttWWWWiiiiddddtttthhhh(((())))
  1723.  
  1724.           int getWidth()
  1725.  
  1726.  
  1727.           Returns the width of _i_m_g.  See also getHeight() and getXsize().
  1728.  
  1729.      ggggeeeettttXXXXssssiiiizzzzeeee(((())))
  1730.  
  1731.           int getXsize()
  1732.  
  1733.  
  1734.           Returns the size of the image in the _x-dimension, measured in
  1735.           pixels.
  1736.  
  1737.           Note that by definition in the IL, the _x-dimension is always the
  1738.           fastest varying dimension in image memory order.  I.e. the scanline
  1739.           dimension.  In non-transposed orientations, scanlines are oriented
  1740.           horizontally with respect to the image.  Thus, for non-transposed
  1741.           orientations getXsize() returns the _w_i_d_t_h of the image.  In
  1742.           transposed orientations the scanlines are oriented vertically with
  1743.           respect to the image and getXsize() returns the _h_e_i_g_h_t of the image.
  1744.           Transposed orientations are: _i_f_l_L_e_f_t_U_p_p_e_r_O_r_i_g_i_n,
  1745.           _i_f_l_R_i_g_h_t_U_p_p_e_r_O_r_i_g_i_n, _i_f_l_R_i_g_h_t_L_o_w_e_r_O_r_i_g_i_n and _i_f_l_L_e_f_t_L_o_w_e_r_O_r_i_g_i_n.
  1746.           See also ggggeeeettttHHHHeeeeiiiigggghhhhtttt(), ggggeeeettttWWWWiiiiddddtttthhhh(), ggggeeeettttSSSSiiiizzzzeeee(), ggggeeeettttYYYYssssiiiizzzzeeee() and
  1747.           ggggeeeettttZZZZssssiiiizzzzeeee().
  1748.  
  1749.      ggggeeeettttYYYYssssiiiizzzzeeee(((())))
  1750.  
  1751.           int getYsize()
  1752.  
  1753.  
  1754.           Returns the size of the image in the _y-dimension, measured in
  1755.           pixels.  See also ggggeeeettttHHHHeeeeiiiigggghhhhtttt(), ggggeeeettttWWWWiiiiddddtttthhhh(), ggggeeeettttSSSSiiiizzzzeeee(), ggggeeeettttXXXXssssiiiizzzzeeee() and
  1756.           ggggeeeettttZZZZssssiiiizzzzeeee().
  1757.  
  1758.      ggggeeeettttZZZZssssiiiizzzzeeee(((())))
  1759.  
  1760.           int getZsize()
  1761.  
  1762.  
  1763.           Returns the size of the image in the _z-dimension. This value can be
  1764.           thought of as representing the number of _x_y planes in an image.  For
  1765.           two-dimensional images, the returned value is 1.  Refer to the
  1766.           _I_m_a_g_e_V_i_s_i_o_n _L_i_b_r_a_r_y _P_r_o_g_r_a_m_m_i_n_g _G_u_i_d_e for more details.  See also
  1767.           ggggeeeettttSSSSiiiizzzzeeee(), ggggeeeettttXXXXssssiiiizzzzeeee() and ggggeeeettttYYYYssssiiiizzzzeeee().
  1768.  
  1769.  
  1770.  
  1771.  
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.                                                                        PPPPaaaaggggeeee 22227777
  1778.  
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1785.  
  1786.  
  1787.  
  1788.      hhhhaaaassssPPPPaaaaggggeeeeBBBBoooorrrrddddeeeerrrr(((())))
  1789.  
  1790.           int hasPageBorder()
  1791.  
  1792.  
  1793.           This functions returns TRUE if the image has page borders, FALSE
  1794.           otherwise.
  1795.  
  1796.      hhhhaaaassssPPPPaaaaggggeeeessss(((())))
  1797.  
  1798.           int hasPages()
  1799.  
  1800.  
  1801.           This virtual function should be defined by derived classes to return
  1802.           TRUE if the class implements paging.  The default implementation
  1803.           returns FALSE.
  1804.  
  1805.      iiiinnnnhhhheeeerrrriiiitttt(((())))
  1806.  
  1807.           int inherit(int typeMask=0, int orderMask=0, int allowDiffColorModels=FALSE)_p_r_o_t_e_c_t_e_d
  1808.  
  1809.  
  1810.           This is a convenience method that can be called in an iiiillllIIIImmmmaaaaggggeeee-
  1811.           derived subclass' rrrreeeesssseeeetttt() method to inherit standard image
  1812.           attributes such as page size, data type, orientation, and so forth,
  1813.           from the image's inputs.  Only those attributes that have not been
  1814.           explicitly set are affected.  The following attributes are set by
  1815.           inherit:
  1816.  
  1817.               color model
  1818.               data type
  1819.               data order
  1820.               data orientation
  1821.               color map
  1822.               size
  1823.               page size
  1824.               min and max values
  1825.  
  1826.  
  1827.           The parameters _t_y_p_e_M_a_s_k and _o_r_d_e_r_M_a_s_k, if non-zero, limit the
  1828.           possible inherited data type and order to the subsets specified in
  1829.           the respective masks.  If _a_l_l_o_w_D_i_f_f_C_o_l_o_r_M_o_d_e_l_s is _T_R_U_E, then the
  1830.           image is allowed to have a different color model than its inputs.
  1831.           Normally, this is not allowed, and a color converting image is
  1832.           automatically inserted to coerce the input color models to the
  1833.           image's color model.
  1834.  
  1835.      iiiinnnniiiittttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  1836.  
  1837.           void initColorModel(int noAlpha=FALSE)                        _p_r_o_t_e_c_t_e_d
  1838.  
  1839.  
  1840.  
  1841.  
  1842.  
  1843.                                                                        PPPPaaaaggggeeee 22228888
  1844.  
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1851.  
  1852.  
  1853.  
  1854.           Initializes the color model based on the number of channels if it
  1855.           has never been explicitly set with sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll().  Images with one
  1856.           channel are set to _i_f_l_L_u_m_i_n_a_n_c_e.  Images with two channel are set to
  1857.           _i_f_l_L_u_m_i_n_a_n_c_e_A_l_p_h_a.  Images with three channels are set to _i_f_l_R_G_B.
  1858.           Images with four channels are set to _i_f_l_R_G_B_A by default.  If _n_o_A_l_p_h_a
  1859.           is true, then images with two or four channels are set to
  1860.           _i_f_l_M_u_l_t_i_S_p_e_c_t_r_a_l instead.  All other cases are set to
  1861.           _i_f_l_M_u_l_t_i_S_p_e_c_t_r_a_l.
  1862.  
  1863.      iiiinnnniiiittttMMMMiiiinnnnMMMMaaaaxxxx(((())))
  1864.  
  1865.           void initMinMax(int force=FALSE)                              _p_r_o_t_e_c_t_e_d
  1866.  
  1867.  
  1868.           Initializes the minimum and maximum value of a pixel based on the
  1869.           data type (for example, 0 and 255) for unsigned char data.  _f_o_r_c_e is
  1870.           FALSE by default, indicating that the minimum and maximum values
  1871.           should not be forced to change if they have already been set.
  1872.  
  1873.      iiiinnnniiiittttPPPPaaaaggggeeeeSSSSiiiizzzzeeee(((())))
  1874.  
  1875.           void initPageSize(const iflSize& pageSize)                 _p_r_o_t_e_c_t_e_d
  1876.           void initPageSize(int nx, int ny, int nz, int nc) _p_r_o_t_e_c_t_e_d
  1877.  
  1878.  
  1879.           Initializes the page size to _p_a_g_e_S_i_z_e only if it has not been
  1880.           previously set (separate flags track whether x/y, z and c values
  1881.           have been set).  The member _p_a_g_e_S_i_z_e_B_y_t_e_s is also computed to match
  1882.           the new page dimensions and the image's data type.
  1883.  
  1884.      iiiinnnniiiittttSSSSccccaaaalllleeeeMMMMiiiinnnnMMMMaaaaxxxx(((())))
  1885.  
  1886.           void initScaleMinMax(int force=FALSE)
  1887.  
  1888.  
  1889.           Initializes the scale minimum and maximum to the image minimum and
  1890.           maximum values. If scale minimum and maximum have already been set,
  1891.           they are unchanged, unless _f_o_r_c_e is TRUE. The scale minimum and
  1892.           maximum are used during color conversion and display.  By default,
  1893.           the scale minimum and maximum track the image minimum and maximum
  1894.           values.
  1895.  
  1896.      iiiissssCCCCoooolllloooorrrrIIIImmmmgggg(((())))
  1897.  
  1898.           int isColorImg()
  1899.  
  1900.  
  1901.           Returns TRUE if the image is a color converter that was created with
  1902.           ggggeeeettttCCCCoooolllloooorrrrIIIImmmmgggg().  Otherwise FALSE is returned.
  1903.  
  1904.  
  1905.  
  1906.  
  1907.  
  1908.  
  1909.                                                                        PPPPaaaaggggeeee 22229999
  1910.  
  1911.  
  1912.  
  1913.  
  1914.  
  1915.  
  1916. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1917.  
  1918.  
  1919.  
  1920.      iiiissssIIIInnnntttteeeeggggrrrraaaallll(((())))
  1921.  
  1922.           int isIntegral()
  1923.  
  1924.  
  1925.           Returns TRUE if the image's data type is an integral valued type. If
  1926.           it is a floating point type, then FALSE is returned. This function
  1927.           is based on the standalone function, iiiiffffllllDDDDaaaattttaaaaIIIIssssIIIInnnntttteeeeggggrrrraaaallll() (see the
  1928.           iflDataSize man page).
  1929.  
  1930.      iiiissssMMMMiiiirrrrrrrroooorrrrOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))
  1931.  
  1932.           int isMirrorOrientation(iflOrientation otherOri,
  1933.                             iflOrientation workOri=iflOrientation(0))
  1934.  
  1935.  
  1936.           The routine returns _T_R_U_E if _o_t_h_e_r_O_r_i is a mirror image of _w_o_r_k_O_r_i.
  1937.           If _w_o_r_k_O_r_i is defaulted, the orientation of the image is used
  1938.           instead.  This can be useful when implementing operations that have
  1939.           calculations that depend on a particular frame of reference.  For
  1940.           example, when implementing an image rotation operator, the angle can
  1941.           need to be negated to produce consistent results on inputs of
  1942.           arbitrary orientation.
  1943.  
  1944.      iiiissssPPPPaaaarrrrttttiiiiaaaallllPPPPaaaaggggeeee(((())))
  1945.  
  1946.           int isPartialPage(int x, int y, int z, int c)          _p_r_o_t_e_c_t_e_d
  1947.  
  1948.  
  1949.           Returns TRUE if the page referenced by the coordinates (_x, _y, _z, _c)
  1950.           is only partially filled with image data; that is, if the page
  1951.           straddles the edge of the image.
  1952.  
  1953.      iiiissssSSSSiiiiggggnnnneeeedddd(((())))
  1954.  
  1955.           int isSigned()
  1956.  
  1957.  
  1958.           Returns TRUE if the image's data type is signed. If it is unsigned,
  1959.           then FALSE is returned. This function is based on the standalone
  1960.           function, iiiiffffllllDDDDaaaattttaaaaIIIIssssSSSSiiiiggggnnnneeeedddd() (see the iflDataSize man page).
  1961.  
  1962.      iiiissssVVVVaaaalllliiiiddddPPPPaaaaggggeeee(((())))
  1963.  
  1964.           int isValidPage(int x, int y, int z, int c)            _p_r_o_t_e_c_t_e_d
  1965.  
  1966.  
  1967.           Returns TRUE if the pixel referenced by the coordinates (_x, _y, _z, _c)
  1968.           is within the image boundary.  The image boundary is defined to be
  1969.           within
  1970.           (-_x_P_a_g_e_B_o_r_d_e_r ,-_y_P_a_g_e_B_o_r_d_e_r, -_z_P_a_g_e_B_o_r_d_e_r, _0) and (_s_i_z_e._x, _s_i_z_e._y,
  1971.           _s_i_z_e._z, _s_i_z_e._c).
  1972.  
  1973.  
  1974.  
  1975.                                                                        PPPPaaaaggggeeee 33330000
  1976.  
  1977.  
  1978.  
  1979.  
  1980.  
  1981.  
  1982. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  1983.  
  1984.  
  1985.  
  1986.      iiiissssWWWWrrrriiiittttaaaabbbblllleeee(((())))
  1987.  
  1988.           int isWritable()
  1989.  
  1990.  
  1991.           This function returns TRUE if the image can be written to; FALSE
  1992.           otherwise.
  1993.  
  1994.      hhhhwwwwDDDDeeeeffffiiiinnnneeee(((())))
  1995.  
  1996.           virtual ilHwOp* hwDefine()                   _p_r_o_t_e_c_t_e_d
  1997.  
  1998.  
  1999.           This virtual returns a new'ed ilHwOp object that specifies the
  2000.           hardware-accelerated implementation of the operation.  Currently,
  2001.           user-defined hardware acceleration is unsupported.  Therefore, you
  2002.           should not override this virtual method.  For more information on
  2003.           hardware acceleration, see ilHwDefs.h and the Programmer's Guide.
  2004.  
  2005.      hhhhwwwwGGGGeeeettttPPPPaaaassssssss(((())))
  2006.  
  2007.           virtual ilHwPass* hwGetPass(const ilHwTarget& target,
  2008.                                       int force=FALSE)
  2009.  
  2010.  
  2011.           This function returns a ilHwPass object for a given _t_a_r_g_e_t (defining
  2012.           the graphics server and visual class).  This ilHwPass object
  2013.           specifies how the operation is performed in the graphics hardware.
  2014.           Currently, user-defined hardware acceleration is unsupported.
  2015.           Therefore, you should not override this virtual method.  For more
  2016.           information on hardware acceleration, see ilHwDefs.h and the
  2017.           Programmer's Guide.
  2018.  
  2019.      lllloooocccckkkkPPPPaaaaggggeeee(((())))
  2020.  
  2021.           ilPage* lockPage(int x, int y, int z, int c, ilStatus& status,
  2022.                            int mode=ilLMread)
  2023.  
  2024.  
  2025.           This is the single page version of lockPageSet(). It returns a
  2026.           pointer to the page containing the pixel _x, _y, _z, _c.  The _s_t_a_t_u_s
  2027.           value specifies the error code if a page could
  2028.            not be referenced.  If the function succeeds, _s_t_a_t_u_s is set to
  2029.           ilOKAY. See qLockPageSet() for a description of _m_o_d_e and possible
  2030.           _s_t_a_t_u_s returns. See also _u_n_l_o_c_k_P_a_g_e().
  2031.  
  2032.      lllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt(((())))
  2033.  
  2034.           ilStatus lockPageSet(ilLockRequest* set, int mode=ilLMread,
  2035.                                int count=1, ilCallback* perPageCb=NULL)
  2036.  
  2037.  
  2038.  
  2039.  
  2040.  
  2041.                                                                        PPPPaaaaggggeeee 33331111
  2042.  
  2043.  
  2044.  
  2045.  
  2046.  
  2047.  
  2048. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2049.  
  2050.  
  2051.  
  2052.           This function queues a list of lock page requests with
  2053.           qqqqLLLLoooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() and waits for them to complete.  Each ilLockRequest
  2054.           in the _s_e_t array is locked and a pointer to the page is deposited in
  2055.           the corresponding ilLockRequest.  As a consequence, this causes all
  2056.           the image data for the pages to be computed.  If all of the requests
  2057.           succeed, ilOKAY is returned.  If one or more fail, an error code
  2058.           will be returned and the ilLockRequest structures will contain
  2059.           individual status codes.  At a later time, uuuunnnnlllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() can be
  2060.           called to release the set of pages.
  2061.  
  2062.           See qqqqLLLLoooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() and uuuunnnnlllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt() for more information.
  2063.  
  2064.      lllloooocccckkkkTTTTiiiilllleeee(((())))
  2065.  
  2066.           ilLockedTile* lockTile(int x, int y, int nx, int ny,
  2067.                          const ilConfig* config=NULL, int mode=ilLMread)
  2068.  
  2069.  
  2070.           This is the 2-D version of lockTile3D().  It calls lockTile3D() with
  2071.           _z set to 0 and _n_z set to 1.
  2072.  
  2073.      lllloooocccckkkkTTTTiiiilllleeee3333DDDD(((())))
  2074.  
  2075.           ilLockedTile* lockTile3D(int x, int y, int z, int nx, int ny, int nz,
  2076.                          const ilConfig* config=NULL, int mode=ilLMread)
  2077.  
  2078.  
  2079.           This function causes the tiles that intersect the indicated image
  2080.           volume to be ``locked.''  This is accomplished by ``locking'' the
  2081.           image pages which store the data for the affected tiles.  These
  2082.           pages remain locked until the ilLockedTile object returned by
  2083.           lockTile3D() is deleted.  The status result of the function can be
  2084.           retrieved by calling the getStatus() method of the returned
  2085.           ilLockedTile object.
  2086.  
  2087.           ``Locking'' is implemented by a virtual function in ilImage.  In the
  2088.           default implementation, copies of the affected pages are computed
  2089.           and stored in locally allocated storage.  Some derived classes
  2090.           provide more interesting implementations which manage shared cache
  2091.           storage, etc.  One example is ilMemCacheImg.
  2092.  
  2093.      mmmmaaaappppFFFFlllliiiippppTTTTrrrraaaannnnssss(((())))
  2094.  
  2095.           iflOrientation mapFlipTrans(iflOrientation fromOrientation,
  2096.                                       iflFlip& flip, int& transXY,
  2097.                                       iflOrientation workOrientation=iflOrientation(0))
  2098.  
  2099.  
  2100.           This function determines the flips and/or transpositions required to
  2101.           map from _f_r_o_m_O_r_i_e_n_t_a_t_i_o_n to _w_o_r_k_O_r_i_e_n_t_a_t_i_o_n (if the work orientation
  2102.           is zero, the image's orientation is used).  The return value is the
  2103.           work orientation.  The required _f_l_i_p and _t_r_a_n_s_X_Y values are also
  2104.  
  2105.  
  2106.  
  2107.                                                                        PPPPaaaaggggeeee 33332222
  2108.  
  2109.  
  2110.  
  2111.  
  2112.  
  2113.  
  2114. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2115.  
  2116.  
  2117.  
  2118.           returned.
  2119.  
  2120.      mmmmaaaappppFFFFrrrroooommmmIIIInnnnppppuuuutttt(((())))
  2121.  
  2122.           virtual ilStatus mapFromInput(float& u, float& v, float& w,
  2123.                                         float x, float y, float z, int idx=0)
  2124.           ilStatus mapFromInput(float& u, float& v, float x, float y, int idx=0)
  2125.           ilStatus mapFromInput(iflXYfloat& uv, const iflXYfloat& xy, int idx=0)
  2126.  
  2127.  
  2128.           Maps a point, (_x,_y,_z), from the _i_d_x'th input image's output
  2129.           coordinate space to this image's output coordinate space and returns
  2130.           the result in (_u,_v,_w).  This virtual function's default
  2131.           implementation is the identity mapping.  It can be overridden in
  2132.           derived classes (like ilWarpImg) to take into account any address
  2133.           manipulations that an operator can perform.  The overloaded versions
  2134.           provide 2D address mapping, which is sufficient for most
  2135.           applications.  Note that the IL does not yet support images with
  2136.           non-identity coordinate mappings in the z dimension, and all
  2137.           coordinates (input and output) are described in the orientation of
  2138.           this image. See also mmmmaaaappppFFFFrrrroooommmmSSSSoooouuuurrrrcccceeee(((()))), mmmmaaaappppTTTTooooIIIInnnnppppuuuutttt(((()))).
  2139.  
  2140.      mmmmaaaappppFFFFrrrroooommmmSSSSoooouuuurrrrcccceeee(((())))
  2141.  
  2142.           ilStatus mapFromSource(float& u, float& v, float& w, float x,
  2143.                                  float y, float z)
  2144.           ilStatus mapFromSource(float& u, float& v, float x, float y)
  2145.           ilStatus mapFromSource(iflXYfloat& self, const iflXYfloat& src)
  2146.  
  2147.  
  2148.           Maps a point, (_x,_y,_z), in the ultimate source image's input
  2149.           coordinate space to this image's output coordinate space and returns
  2150.           the result in (_u,_v,_w).  Both points are defined in this image's
  2151.           orientation. One possible use for this is to determine where to plot
  2152.           annotation that is tied to the source image when zooming and
  2153.           rotating an image.  The ilView function, sssseeeettttLLLLoooocccc(((()))), also uses this
  2154.           function to position a location in the source image of an operator
  2155.           chain at the center of the viewed region.  The overloaded versions
  2156.           provide 2D address mapping, which is sufficient for most
  2157.           applications.  Note that the IL does not yet support images with
  2158.           non-identity coordinate mappings in the z dimension.  See also
  2159.           mmmmaaaappppTTTTooooSSSSoooouuuurrrrcccceeee(((()))), mmmmaaaappppFFFFrrrroooommmmIIIInnnnppppuuuutttt(((()))) and the ilView man page.
  2160.  
  2161.      mmmmaaaappppSSSSiiiizzzzeeee(((())))
  2162.  
  2163.           void mapSize(iflOrientation fromOri, int& x, int& y,
  2164.                        iflOrientation workOri=iflOrientation(0))
  2165.  
  2166.  
  2167.           Transposes the _x and _y size as needed, based on _f_r_o_m_O_r_i and _w_o_r_k_O_r_i.
  2168.           If _w_o_r_k_O_r_i is 0, then the image's orientation is used.
  2169.  
  2170.  
  2171.  
  2172.  
  2173.                                                                        PPPPaaaaggggeeee 33333333
  2174.  
  2175.  
  2176.  
  2177.  
  2178.  
  2179.  
  2180. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2181.  
  2182.  
  2183.  
  2184.      mmmmaaaappppOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))
  2185.  
  2186.           iflOrientation mapOrientation(int flipX, int flipY, int transXY=FALSE)
  2187.  
  2188.  
  2189.           The function returns the orientation that results from applying the
  2190.           flips and transpose requested to the image's orientation.  If _f_l_i_p_X
  2191.           is TRUE, the _x dimension is flipped.  If _f_l_i_p_Y is TRUE, the _y
  2192.           dimension is flipped.  If _t_r_a_n_s_X_Y is TRUE, the _x and _y dimensions
  2193.           are transposed.
  2194.  
  2195.      mmmmaaaappppTTTTiiiilllleeee(((())))
  2196.  
  2197.           void mapTile(iflOrientation fromOri, iflTile2Dint& tile,
  2198.                        iflOrientation workOri=iflOrientation(0))
  2199.           void mapTile(iflOrientation fromOri, iflTile2Dfloat& tile,
  2200.                        iflOrientation workOri=iflOrientation(0))
  2201.           void mapTile(iflOrientation fromOri, iflTile2Dint &tile, iflFlip &flip,
  2202.                        int &transXY, iflOrientation workOri=iflOrientation(0))
  2203.  
  2204.  
  2205.           The tile referenced by _t_i_l_e is mapped from orientation _f_r_o_m_O_r_i to
  2206.           the orientation _w_o_r_k_O_r_i.  If _w_o_r_k_O_r_i is defaulted, the orientation
  2207.           of the image is used instead.  The origin and size members of _t_i_l_e
  2208.           are recomputed to reflect this mapping.  The value returned in the
  2209.           iflFlip enumerated type, _f_l_i_p indicates whether the _x or the _y axis,
  2210.           or both, had to be flipped to effect the mapping.
  2211.  
  2212.           If no flipping was required, then _i_f_l_N_o_F_l_i_p is returned.  If the _x
  2213.           or _y axis was flipped, _i_f_l_X_F_l_i_p or _i_f_l_Y_F_l_i_p is returned.  If both
  2214.           axes were flipped, (_i_f_l_X_F_l_i_p | _i_f_l_Y_F_l_i_p) is returned. If, to effect
  2215.           the mapping, the x and y axes had to be interchanged (that is, the
  2216.           new x origin and size are the old y origin and size and the converse
  2217.           is true), then a 1 is returned in _t_r_a_n_s_X_Y; otherwise _t_r_a_n_s_X_Y is 0.
  2218.  
  2219.      mmmmaaaappppTTTTooooIIIInnnnppppuuuutttt(((())))
  2220.  
  2221.           virtual ilStatus mapToInput(float& x, float& y, float& z,
  2222.                                   float u, float v, float w, int idx=0)
  2223.           ilStatus mapToInput(float& x, float& y, float u, float v, int idx=0)
  2224.           ilStatus mapToInput(iflXYfloat& xy, const iflXYfloat& uv, int idx=0)
  2225.  
  2226.  
  2227.           Maps a point, (_u,_v,_w), in this image's output coordinate space to
  2228.           the _i_d_x'th input image's output coordinate space and returns the
  2229.           result in (_x,_y,_z).  This virtual function's default implementation
  2230.           assumes the identity mapping.  It can be overridden in derived
  2231.           classes (like ilWarpImg) to take into account any address
  2232.           manipulations that an operator can perform.  The overloaded versions
  2233.           provide 2D address mapping, which is sufficient for most
  2234.           applications.  Note that the IL does not yet support images with
  2235.           non-identity coordinate mappings in the z dimension, and all points
  2236.  
  2237.  
  2238.  
  2239.                                                                        PPPPaaaaggggeeee 33334444
  2240.  
  2241.  
  2242.  
  2243.  
  2244.  
  2245.  
  2246. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2247.  
  2248.  
  2249.  
  2250.           are defined in the orientation of this image. See also
  2251.           mmmmaaaappppTTTTooooSSSSoooouuuurrrrcccceeee(((()))), mmmmaaaappppFFFFrrrroooommmmIIIInnnnppppuuuutttt(((()))).
  2252.  
  2253.      mmmmaaaappppTTTTooooSSSSoooouuuurrrrcccceeee(((())))
  2254.  
  2255.           ilStatus mapToSource(float& x, float& y, float& z, float u,
  2256.               float v, float w)
  2257.           ilStatus mapToSource(float& x, float& y, float u, float v)
  2258.           ilStatus mapToSource(iflXYfloat& src, const iflXYfloat& self)
  2259.  
  2260.  
  2261.           Maps a point, (_u,_v,_w), in this image's output coordinate space to
  2262.           the ultimate source image's input coordinate space and returns the
  2263.           result in (_x,_y,_z).  All coordinates are defined in this image's
  2264.           orientation.  One possible use for this is to find the source image
  2265.           coordinates of a screen location in a zoomed and rotated image.  The
  2266.           ilView function, ggggeeeettttLLLLoooocccc(((()))), uses this function to accomplish this
  2267.           task.  The overloaded versions provide 2D address mapping, which is
  2268.           sufficient for most applications.  Note that the IL does not yet
  2269.           support images with non-identity coordinate mappings in the z
  2270.           dimension.  See also mmmmaaaappppFFFFrrrroooommmmSSSSoooouuuurrrrcccceeee(((()))), mmmmaaaappppTTTTooooIIIInnnnppppuuuutttt(((()))) and the ilView
  2271.           man page.
  2272.  
  2273.      mmmmaaaappppXXXXYYYY(((())))
  2274.  
  2275.           void mapXY(iflOrientation fromOri, int& x, int& y,
  2276.                      iflOrientation workOri=iflOrientation(0))
  2277.           void mapXY(iflOrientation fromOri, float& x, float& y,
  2278.                      iflOrientation workOri=iflOrientation(0))
  2279.           void mapXYSign(iflOrientation fromOri, float& x, float& y,
  2280.                      iflOrientation workOri=iflOrientation(0))
  2281.  
  2282.  
  2283.           The (x,y) pair of values referenced by _x and _y is mapped from
  2284.           orientation _f_r_o_m_O_r_i to the orientation _w_o_r_k_O_r_i.  If _w_o_r_k_O_r_i is
  2285.           defaulted, the orientation of the image is used instead.  In the
  2286.           _i_l_M_a_p_X_Y_S_i_g_n function, if a flip in the _x or _y dimensions is required
  2287.           to transform between the two orienations, the _x and _y values are
  2288.           negated accordingly.  If a transpose is required, the _x and _y values
  2289.           are swapped.
  2290.  
  2291.      oooouuuuttttOOOOffffBBBBoooouuuunnnndddd(((())))
  2292.  
  2293.           int outOfBound(int x, int y)                                  _p_r_o_t_e_c_t_e_d
  2294.           int outOfBound(int x, int y, int z)                           _p_r_o_t_e_c_t_e_d
  2295.  
  2296.  
  2297.           Returns TRUE if the specified point is outside of the image.
  2298.           Provided as a convenience for derived classes.
  2299.  
  2300.  
  2301.  
  2302.  
  2303.  
  2304.  
  2305.                                                                        PPPPaaaaggggeeee 33335555
  2306.  
  2307.  
  2308.  
  2309.  
  2310.  
  2311.  
  2312. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2313.  
  2314.  
  2315.  
  2316.      qqqqCCCCooooppppyyyyTTTTiiiilllleeeeCCCCffffgggg(((())))
  2317.  
  2318.           virtual ilStatus qCopyTileCfg(ilMpNode* parent, int x, int y, int z,
  2319.                                int nx, int ny, int nz, ilImage* other,
  2320.                                int ox, int oy, int oz,
  2321.                                const ilConfig* config=NULL,
  2322.                                ilMpManager** pMgr=NULL)
  2323.  
  2324.  
  2325.           This virtual function should be defined by derived classes to queue
  2326.           a request to copy a tile from the _o_t_h_e_r image to this image object.
  2327.           The tile is copied to location _x, _y, _z in this image; the tile size
  2328.           is specified by _n_x, _n_y, _n_z.  The source tile is at location _o_x, _o_y,
  2329.           _o_z in the _o_t_h_e_r image.  The _c_o_n_f_i_g parameter may be used to specify
  2330.           a channel list and/or offset (the other fields are ignored).
  2331.  
  2332.           If the _o_t_h_e_r image has a different data type or order than this
  2333.           image, then the data is converted as it is copied.  If the two
  2334.           image's color models are different, a color converter is chained
  2335.           onto the _o_t_h_e_r image UNLESS a channel list or offset is specified
  2336.           with _c_o_n_f_i_g; the channel re-ordering will be presumed to resolve any
  2337.           color model difference.
  2338.  
  2339.           The _p_a_r_e_n_t MP node (if not NULL) will have this operation added as a
  2340.           dependent node.  The MP manager for this queued operation will be
  2341.           returned via the _p_M_g_r parameter (if not NULL) and can then used to
  2342.           wait for completion, obtain a status code, and/or abort.  For more
  2343.           information on MP synchronization, see the ilMpManager man page.
  2344.  
  2345.      qqqqFFFFiiiillllllllTTTTiiiilllleeee3333DDDD(((())))
  2346.  
  2347.           virtual ilStatus qFillTile3D(ilMpNode* parent, int x, int y, int z,
  2348.                               int nx, int ny, int nz, const void* data,
  2349.                               const ilConfig* config=NULL,
  2350.                               const iflTile3Dint* fillMask=NULL,
  2351.                               ilMpManager** pMgr=NULL);
  2352.  
  2353.  
  2354.           This virtual function should be defined by derived classes to queue
  2355.           a request to fill a tile at location _x, _y, _z of size _n_x, _n_y _n_z with
  2356.           a constant pixel value, defined by _d_a_t_a.  The ilConfig object,
  2357.           _c_o_n_f_i_g, (if not NULL) can specify a data type and order for the fill
  2358.           value as well as a channel list or offset.  If _c_o_n_f_i_g specifies an
  2359.           orientation, it is used to map the tile coordinates to the image's
  2360.           orientation.  The _f_i_l_l_M_a_s_k (if not NULL) defines a region within the
  2361.           fill area that is not to be filled; it should be specified in the
  2362.           same orientation as the tile.
  2363.  
  2364.           The _p_a_r_e_n_t MP node (if not NULL) will have this operation added as a
  2365.           dependent node.  The MP manager for this queued operation will be
  2366.           returned via the _p_M_g_r parameter (if not NULL) and can then used to
  2367.           wait for completion, obtain a status code, and/or abort.  For more
  2368.  
  2369.  
  2370.  
  2371.                                                                        PPPPaaaaggggeeee 33336666
  2372.  
  2373.  
  2374.  
  2375.  
  2376.  
  2377.  
  2378. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2379.  
  2380.  
  2381.  
  2382.           information on MP synchronization, see the ilMpManager man page.
  2383.  
  2384.      qqqqFFFFiiiillllllllTTTTiiiilllleeeeRRRRGGGGBBBB(((())))
  2385.  
  2386.           virtual ilStatus qFillTileRGB(ilMpNode* parent, int x, int y, int z,
  2387.                                int nx, int ny, int nz,
  2388.                                float red, float green, float blue,
  2389.                                const iflTile3Dint* fillMask=NULL,
  2390.                                iflOrientation orientation=iflOrientation(0),
  2391.                                ilMpManager** pMgr=NULL);
  2392.  
  2393.  
  2394.           This virtual function should be defined to queue a fill tile request
  2395.           in a manner similar to qqqqFFFFiiiillllllllTTTTiiiilllleeee3333DDDD(), except that the fill value is
  2396.           specified with _r_e_d, _g_r_e_e_n, _b_l_u_e pixel components.  The _o_r_i_e_n_t_a_t_i_o_n
  2397.           (if not zero) is used to map the tile and mask coordinates to the
  2398.           image's orientation.
  2399.  
  2400.      qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((())))
  2401.  
  2402.           virtual ilStatus qGetSubTile3D(ilMpNode* parent, int x, int y, int z,
  2403.                                 int nx, int ny, int nz, void*& data,
  2404.                                 int dx, int dy, int dz,
  2405.                                 int dnx, int dny, int dnz,
  2406.                                 const ilConfig* config=NULL,
  2407.                                 ilMpManager** pMgr=NULL);
  2408.  
  2409.  
  2410.           This virtual function should be defined by derived classes to queue
  2411.           a read request for an arbitrary rectangular tile of data.  The data
  2412.           should be returned in the buffer pointed to by _d_a_t_a.  The source
  2413.           tile origin is specified by _x, _y, _z, and the tile size is specified
  2414.           by _n_x, _n_y, _n_z.  The destination buffer origin _d_x, _d_y, _d_z and size
  2415.           _d_n_x, _d_n_y, _d_n_z may be different from the source tile; in this case,
  2416.           the source tile will be properly integrated into the destination
  2417.           buffer.
  2418.  
  2419.           The ilConfig object, _c_o_n_f_i_g, may be used to specify the data type,
  2420.           order, number of channels and channel order desired for the buffer.
  2421.           If _c_o_n_f_i_g is NULL (the default) then no conversion is performed.
  2422.           Otherwise, if the configuration specifies attributes different from
  2423.           those of the image, then the data is converted as it is copied into
  2424.           the buffer.
  2425.  
  2426.           The configuration may also include a channel list; it should have as
  2427.           many entries as there are channels in the buffer.  A -1  means no
  2428.           data is written for that channel. For example, if this image has
  2429.           four channels and the number of channels in _c_o_n_f_i_g is 3 and the
  2430.           channel list is (1, -1, 3), then channels 1 and 3 of this image are
  2431.           read into channels 0 and 2 of the buffer in the data type and order
  2432.           specified in _c_o_n_f_i_g. Channel 1 in the buffer remains unchanged. See
  2433.           also the ilConfig man page.
  2434.  
  2435.  
  2436.  
  2437.                                                                        PPPPaaaaggggeeee 33337777
  2438.  
  2439.  
  2440.  
  2441.  
  2442.  
  2443.  
  2444. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2445.  
  2446.  
  2447.  
  2448.           The _p_a_r_e_n_t MP node (if not NULL) will have this operation added as a
  2449.           dependent node.  The MP manager for this queued operation will be
  2450.           returned via the _p_M_g_r parameter (if not NULL) and can then used to
  2451.           wait for completion, obtain a status code, and/or abort.  For more
  2452.           information on MP synchronization, see the ilMpManager man page.
  2453.  
  2454.      qqqqGGGGeeeettttTTTTiiiilllleeee3333DDDD(((())))
  2455.  
  2456.           ilStatus qGetTile3D(ilMpNode* parent, int x, int y, int z,
  2457.                         int nx, int ny, int nz, void*& data,
  2458.                         const ilConfig* config=NULL, ilMpManager** pMgr=NULL)
  2459.  
  2460.  
  2461.           This function calls qqqqGGGGeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() with the destination tile
  2462.           position and size equal to that of the source tile.
  2463.  
  2464.      qqqqLLLLoooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt(((())))
  2465.  
  2466.           virtual ilStatus qLockPageSet(ilMpNode* parent, ilLockRequest* set,
  2467.                                         int mode=ilLMread, int count=1,
  2468.                                         ilMpManager** pMgr=NULL,
  2469.                                         ilCallback* perPageCb=NULL)
  2470.  
  2471.  
  2472.           This virtual function should be defined by derived classes to queue
  2473.           a request to lock pages in memory.
  2474.  
  2475.           The _s_e_t parameter is a pointer to an array of _c_o_u_n_t ilLockRequest
  2476.           structures:
  2477.  
  2478.                _s_t_r_u_c_t _i_l_L_o_c_k_R_e_q_u_e_s_t : _p_u_b_l_i_c _i_l_X_Y_Z_C_S_i_n_t {
  2479.                    _i_l_S_t_a_t_u_s _s_t_a_t_u_s;
  2480.                    _i_l_P_a_g_e* _p_a_g_e;
  2481.                    _v_o_i_d _i_n_i_t(_i_n_t _X, _i_n_t _Y, _i_n_t _Z, _i_n_t _C);
  2482.                };
  2483.  
  2484.           Each ilLockRequest structure specifies a request for a pointer to
  2485.           the page containing the pixel _X, _Y, _Z, _C.  After the lock request
  2486.           completes each of the _s_t_a_t_u_s codes will be filled in and _p_a_g_e will
  2487.           point at the page containing the requested pixel.  If _s_t_a_t_u_s is not
  2488.           ilOKAY or _X, _Y, _Z, _C references an invalid page, _p_a_g_e will be NULL.
  2489.  
  2490.           The _m_o_d_e parameter is a logical OR of the following mode values:
  2491.  
  2492.                _n_a_m_e           _b_i_t_s     _m_e_a_n_i_n_g
  2493.                _________________________________________________________
  2494.                ilLMpriority   0x0ff    cache priority: 0(low) -> 7(high)
  2495.                ilLMread       0x100    read access
  2496.                ilLMwrite      0x200    write access (mark dirty)
  2497.                ilLMseek       0x400    load into cache without locking
  2498.  
  2499.  
  2500.  
  2501.  
  2502.  
  2503.                                                                        PPPPaaaaggggeeee 33338888
  2504.  
  2505.  
  2506.  
  2507.  
  2508.  
  2509.  
  2510. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2511.  
  2512.  
  2513.  
  2514.                ilLMfail       0x800    succeed only if resident
  2515.                ilLMforceMP    0x1000   force MP manager to be created
  2516.  
  2517.           If _m_o_d_e includes ilLMfail, then the status will be set to
  2518.           ilNOTRESIDENT if the page is not resident in cache, instead of
  2519.           forcing the page to be made resident.  See the header file
  2520.           <_i_l/_i_l_E_r_r_o_r._h> for other status values.
  2521.  
  2522.           In the default implementation in the ilImage base class, copies of
  2523.           pages are returned in locally allocated memory.  Subsequent calls to
  2524.           lock the same pages will return new copies.  This default
  2525.           implementation ignores the _m_o_d_e parameter.  Some derived classes
  2526.           provide more interesting implementations which manage shared cache
  2527.           storage, etc.  One example is ilMemCacheImg.
  2528.  
  2529.           The _p_a_r_e_n_t MP node (if not NULL) will have this operation added as a
  2530.           dependent node.  The MP manager for this queued operation will be
  2531.           returned via the _p_M_g_r parameter (if not NULL) and can then used to
  2532.           wait for completion, obtain a status code, and/or abort.  For more
  2533.           information on MP synchronization, see the ilMpManager man page.
  2534.  
  2535.           Alternatively (or in addition), an ilPage callback, _p_e_r_P_a_g_e_C_b, can
  2536.           be specified; if not NULL, it will be invoked as each page is locked
  2537.           (see the ilPage man page for info on how to declare a paging
  2538.           callback).
  2539.  
  2540.      qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(((())))
  2541.  
  2542.           virtual ilStatus qSetSubTile3D(ilMpNode* parent, int x, int y, int z,
  2543.                                          int nx, int ny, int nz, const void* data,
  2544.                                          int dx, int dy, int dz,
  2545.                                          int dnx, int dny, int dnz,
  2546.                                          const ilConfig* config=NULL,
  2547.                                          ilMpManager** pMgr=NULL)
  2548.  
  2549.  
  2550.           This virtual function should be defined by derived classes to queue
  2551.           a request to write an arbitrary tile of data taken from the buffer
  2552.           pointed to by _d_a_t_a.  The image tile origin is specified by _x, _y, _z,
  2553.           and the tile size is specified by _n_x, _n_y, _n_z.  The source buffer's
  2554.           origin _d_x, _d_y, _d_z and size _d_n_x, _d_n_y, _d_n_z may be different from the
  2555.           image tile; in this case, only the intersection of the two tiles is
  2556.           copied.
  2557.  
  2558.           The ilConfig object, _c_o_n_f_i_g, may be used to specify the data type,
  2559.           order, color model, number of channels and channel order of the
  2560.           buffer. If _c_o_n_f_i_g is NULL (the default) then no conversion is
  2561.           performed.  Otherwise, if the configuration specifies attributes
  2562.           different from those of the image, then the data is converted as it
  2563.           is written to the image.
  2564.  
  2565.  
  2566.  
  2567.  
  2568.  
  2569.                                                                        PPPPaaaaggggeeee 33339999
  2570.  
  2571.  
  2572.  
  2573.  
  2574.  
  2575.  
  2576. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2577.  
  2578.  
  2579.  
  2580.           The configuration may also include a channel list; it should have as
  2581.           many entries as there are channels in the buffer.  A -1  means no
  2582.           data is written for that channel. For example, if this image has
  2583.           four channels and the number of channels in _c_o_n_f_i_g is 3 and the
  2584.           channel list is (1, -1, 3), then channels 1 and 3 of this image are
  2585.           read into channels 0 and 2 of the buffer in the data type and order
  2586.           specified in _c_o_n_f_i_g. Channel 1 in the buffer remains unchanged. See
  2587.           also the ilConfig man page.
  2588.  
  2589.           The _p_a_r_e_n_t MP node (if not NULL) will have this operation added as a
  2590.           dependent node.  The MP manager for this queued operation will be
  2591.           returned via the _p_M_g_r parameter (if not NULL) and can then used to
  2592.           wait for completion, obtain a status code, and/or abort.  For more
  2593.           information on MP synchronization, see the ilMpManager man page.
  2594.  
  2595.           This is a virtual function and should be defined by derived classes.
  2596.           See also sssseeeettttTTTTiiiilllleeee(), and ggggeeeettttCCCCoooonnnnffffiiiigggg().
  2597.  
  2598.      qqqqSSSSeeeettttTTTTiiiilllleeee3333DDDD(((())))
  2599.  
  2600.           ilStatus qSetTile3D(ilMpNode* parent, int x, int y, int z,
  2601.                               int nx, int ny, int nz, void* data,
  2602.                               const ilConfig* config=NULL, ilMpManager** pMgr=NULL)
  2603.  
  2604.  
  2605.           This function is a call-through to qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() with the buffer
  2606.           tile position and size equal to the image tile position and size.
  2607.  
  2608.      rrrreeeemmmmoooovvvveeeeIIIInnnnppppuuuutttt(((())))
  2609.  
  2610.           ilStatus removeInput(int idx = 0)
  2611.  
  2612.  
  2613.           Removes the image at index _i_d_x from the input (parent) list. If
  2614.           successful, ilOKAY is returned. The default index is 0.
  2615.  
  2616.      sssseeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  2617.  
  2618.           ilStatus setColormap(const iflColormap &cmap)
  2619.  
  2620.  
  2621.           Sets the image's color map to the given iflColormap.  If successful,
  2622.           ilOKAY is returned.  See also ggggeeeettttCCCCoooolllloooorrrrmmmmaaaapppp() and iflColormap.
  2623.  
  2624.      sssseeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  2625.  
  2626.           ilStatus setColorModel(iflColorModel c)
  2627.  
  2628.  
  2629.           Sets the image's color model to the enumerated type, _i_f_l_C_o_l_o_r_M_o_d_e_l,
  2630.           specified by _c. If successful, ilOKAY is returned.  See also
  2631.           ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll().
  2632.  
  2633.  
  2634.  
  2635.                                                                        PPPPaaaaggggeeee 44440000
  2636.  
  2637.  
  2638.  
  2639.  
  2640.  
  2641.  
  2642. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2643.  
  2644.  
  2645.  
  2646.      sssseeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn(((())))
  2647.  
  2648.           ilStatus setCompression(iflCompression c)
  2649.  
  2650.  
  2651.           Sets the image's compression scheme to the enumerated type,
  2652.           _i_f_l_C_o_m_p_r_e_s_s_i_o_n, specified by _c.  If successful, ilOKAY is returned.
  2653.           See also ggggeeeettttCCCCoooommmmpppprrrreeeessssssssiiiioooonnnn().
  2654.  
  2655.      sssseeeettttDDDDiiiissssppppllllaaaayyyyCCCCaaaacccchhhheeeeEEEEnnnnaaaabbbblllleeee(((())))
  2656.  
  2657.           void setDisplayCacheEnable(int en=TRUE)                    _p_r_o_t_e_c_t_e_d
  2658.  
  2659.  
  2660.           If the enable is _T_R_U_E and this image is not hardware accelerated,
  2661.           then an iiiillllNNNNooooppppIIIImmmmgggg is automatically chained onto the image when it is
  2662.           displayed in order to cache the image data for improved interactive
  2663.           display.  You shouldn't set this enable for images derived from
  2664.           iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg because such objects have cache's of their own.  It
  2665.           does make sense to set it for an uncached, unaccelerated image such
  2666.           as iiiillllJJJJooooiiiinnnnIIIImmmmgggg.
  2667.  
  2668.      sssseeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))
  2669.  
  2670.           ilStatus setOrientation(iflOrientation spc)
  2671.  
  2672.  
  2673.           Sets the image's orientation to the enumerated type, _i_f_l_O_r_i_e_n_t_a_t_i_o_n,
  2674.           specified by _s_p_c. This parameter determines whether the image origin
  2675.           is, for example, the upper left corner or the lower left corner. See
  2676.           also ggggeeeettttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn().
  2677.  
  2678.      sssseeeettttCCCCssssiiiizzzzeeee(((())))
  2679.  
  2680.           ilStatus setCsize(int nc)
  2681.           ilStatus setNumChans(int nc)
  2682.  
  2683.  
  2684.           Sets the number of channels in the image. Each pixel has _n_c channels
  2685.           or components. Returns ilOKAY upon successful completion.
  2686.  
  2687.      sssseeeettttDDDDaaaattttaaaaTTTTyyyyppppeeee(((())))
  2688.  
  2689.           ilStatus setDataType(iflDataType dtype)
  2690.  
  2691.  
  2692.           Sets the image data type to the enumerated type, _i_f_l_D_a_t_a_T_y_p_e,
  2693.           specified by _d_t_y_p_e. Returns ilOKAY upon successful completion.
  2694.  
  2695.  
  2696.  
  2697.  
  2698.  
  2699.  
  2700.  
  2701.                                                                        PPPPaaaaggggeeee 44441111
  2702.  
  2703.  
  2704.  
  2705.  
  2706.  
  2707.  
  2708. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2709.  
  2710.  
  2711.  
  2712.      sssseeeettttFFFFiiiillllllll(((())))
  2713.  
  2714.           ilStatus setFill(const iflPixel& pixel)
  2715.  
  2716.  
  2717.           Sets the image's fill value data member to the values in _p_i_x_e_l.
  2718.           When ggggeeeettttTTTTiiiilllleeee() or ccccooooppppyyyyTTTTiiiilllleeee() try to access pixels that are beyond
  2719.           the image's edge, those pixels are set to the fill value.  The
  2720.           iflPixel type is defined in its header file as consisting of an
  2721.           iflDataType that defines the data type of the image's pixels, an iiiinnnntttt
  2722.           specifying the number of channels of data, and a pointer to the
  2723.           actual pixel data.  See also ggggeeeettttFFFFiiiillllllll() and cccclllliiiippppTTTTiiiilllleeee().
  2724.  
  2725.      sssseeeettttFFFFiiiillllllllRRRRGGGGBBBB(((())))
  2726.  
  2727.           ilStatus setFillRGB(float red, float green, float blue)
  2728.  
  2729.  
  2730.           Sets the image fill value to a pixel whose elements will be
  2731.           interpreted as the color indicated by _r_e_d, _g_r_e_e_n and _b_l_u_e.  The
  2732.           values for the color triplet should be in the range from zero to
  2733.           one.  See also sssseeeettttFFFFiiiillllllll().  sssseeeettttFFFFiiiillllllllVVVVaaaalllluuuueeee(((())))
  2734.  
  2735.           ilStatus setFillValue(double val, int c=0)
  2736.  
  2737.  
  2738.           Sets the image fill value for channel _c to _v_a_l.  See also sssseeeettttFFFFiiiillllllll().
  2739.  
  2740.      sssseeeettttHHHHwwwwEEEEnnnnaaaabbbblllleeee(((())))
  2741.  
  2742.           void setHwEnable(ilHwAccelEnable enable)
  2743.  
  2744.  
  2745.           This function enables or disables hardware acceleration for this
  2746.           image object.  If acceleration is successfully enabled, the image
  2747.           will derive a performance improvement by using the installed
  2748.           graphics hardware of the system.  See the man page for
  2749.           _i_l_H_w_A_c_c_e_l_e_r_a_t_e.
  2750.  
  2751.      sssseeeettttIIIInnnnppppuuuutttt(((())))
  2752.  
  2753.           ilStatus setInput(ilImage* inimg, int idx = 0)
  2754.  
  2755.  
  2756.           Inserts the image _i_n_i_m_g into the input (parent) list at index _i_d_x.
  2757.           By default, the image is inserted at index 0.  Returns ilOKAY upon
  2758.           successful completion.  See also aaaaddddddddIIIInnnnppppuuuutttt().
  2759.  
  2760.  
  2761.  
  2762.  
  2763.  
  2764.  
  2765.  
  2766.  
  2767.                                                                        PPPPaaaaggggeeee 44442222
  2768.  
  2769.  
  2770.  
  2771.  
  2772.  
  2773.  
  2774. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2775.  
  2776.  
  2777.  
  2778.      sssseeeettttMMMMaaaaxxxxCCCCoooolllloooorrrrmmmmaaaappppLLLLeeeevvvveeeellllssss(((())))
  2779.  
  2780.           void setMaxColormapLevels(int maxLevels)
  2781.  
  2782.  
  2783.           This function sets the maximum number of color levels for optimal
  2784.           color map generation for this image object.  This value may be used
  2785.           to generate a color map when displaying the image if an explicit
  2786.           color map is not supplied.
  2787.  
  2788.      sssseeeettttMMMMaaaaxxxxVVVVaaaalllluuuueeee(((())))
  2789.  
  2790.           ilStatus setMaxValue(double val)
  2791.  
  2792.  
  2793.           Sets the maximum allowable value for all channels.
  2794.  
  2795.      sssseeeettttMMMMiiiinnnnVVVVaaaalllluuuueeee(((())))
  2796.  
  2797.           ilStatus setMinValue(double val)
  2798.  
  2799.  
  2800.           Sets the minimum allowable value for all channels.
  2801.  
  2802.      sssseeeettttNNNNuuuummmmIIIInnnnppppuuuuttttssss(((())))
  2803.  
  2804.           void setNumInputs(int num)                                    _p_r_o_t_e_c_t_e_d
  2805.  
  2806.  
  2807.           Sets the maximum number of inputs allowed by this image to _n_u_m. The
  2808.           maximum number of inputs is checked by aaaaddddddddIIIInnnnppppuuuutttt() and by sssseeeettttIIIInnnnppppuuuutttt().
  2809.  
  2810.      sssseeeettttOOOOrrrrddddeeeerrrr(((())))
  2811.  
  2812.           ilStatus setOrder(iflOrder order)
  2813.  
  2814.  
  2815.           Sets the pixel channel order of this image to _o_r_d_e_r. The enumerated
  2816.           type, _i_f_l_O_r_d_e_r can be one of _i_l_I_n_t_e_r_l_e_a_v_e_d, _i_l_S_e_q_u_e_n_t_i_a_l or
  2817.           _i_l_S_e_p_a_r_a_t_e.  Returns ilOKAY upon successful completion. See also
  2818.           ggggeeeettttOOOOrrrrddddeeeerrrr().
  2819.  
  2820.      sssseeeettttPPPPaaaaggggeeeeBBBBoooorrrrddddeeeerrrr(((())))
  2821.  
  2822.           ilStatus setPageBorder(const iflXYZint& border)
  2823.           ilStatus setPageBorder(int nx, int ny, int nz=0)
  2824.  
  2825.  
  2826.           Sets the current page border size to _n_x, _n_y, _n_z.
  2827.  
  2828.  
  2829.  
  2830.  
  2831.  
  2832.  
  2833.                                                                        PPPPaaaaggggeeee 44443333
  2834.  
  2835.  
  2836.  
  2837.  
  2838.  
  2839.  
  2840. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2841.  
  2842.  
  2843.  
  2844.      sssseeeettttPPPPaaaaggggeeeeSSSSiiiizzzzeeee(((())))
  2845.  
  2846.           ilStatus setPageSize(const iflSize& pageSize)
  2847.           ilStatus setPageSize(int nx, int ny, int nz, int nc)
  2848.           ilStatus setPageSize(int nx, int ny)
  2849.           ilStatus setPageSizeZ(int nz)
  2850.           ilStatus setPageSizeC(int nc)
  2851.  
  2852.  
  2853.           Functions to set the page size.  For each of the versions of this
  2854.           function, the x size is set to _n_x, the y size is set to _n_y, the z
  2855.           size is set to _n_z, and the number of channels is set to _n_c.  See
  2856.           also ilCacheImg.  If the number of channels is set to 0 (or is not
  2857.           set), it is then up to the derived classes to set the actual _c
  2858.           dimension of the page. One might, in a derived class, check the
  2859.           order of the data and then set the _c dimension to 1 for _i_f_l_S_e_p_a_r_a_t_e
  2860.           data or to the number of image channels for _i_f_l_I_n_t_e_r_l_e_a_v_e_d or
  2861.           _i_f_l_S_e_q_u_e_n_t_i_a_l data.
  2862.  
  2863.      sssseeeettttPPPPiiiixxxxeeeellll(((())))
  2864.  
  2865.           ilStatus setPixel(int x, int y, iflPixel& pix)
  2866.  
  2867.  
  2868.           This function is the 2-D version of sssseeeettttPPPPiiiixxxxeeeellll3333DDDD().  It calls
  2869.           sssseeeettttPPPPiiiixxxxeeeellll3333DDDD() with _z set to 0.  See also sssseeeettttPPPPiiiixxxxeeeellll3333DDDD().
  2870.  
  2871.      sssseeeettttPPPPiiiixxxxeeeellll3333DDDD(((())))
  2872.  
  2873.           ilStatus setPixel3D(int x, int y, int z, iflPixel& pix)
  2874.  
  2875.  
  2876.           Writes the iflPixel specified by _p_i_x to the location specified by _x,
  2877.           _y, and _z.  An iflPixel specifies the channel data type, the number
  2878.           of channels per pixel and a pointer to the pixel data.  This
  2879.           function calls sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() with the tile size _n_x, _n_y and _n_z set
  2880.           to 1. Returns ilOKAY upon successful completion. See also
  2881.           ggggeeeettttPPPPiiiixxxxeeeellll3333DDDD() and sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD(), sssseeeettttPPPPiiiixxxxeeeellll().
  2882.  
  2883.      sssseeeettttPPPPrrrriiiioooorrrriiiittttyyyy(((())))
  2884.  
  2885.           void setPriority(int pri)
  2886.  
  2887.  
  2888.           This function sets the cache priority of this image, the default is
  2889.           zero (the lowest priority).  By setting a larger value (up to the
  2890.           maximum of 7), the likelihood that this image's pages will stay in
  2891.           the global cache is increased.
  2892.  
  2893.  
  2894.  
  2895.  
  2896.  
  2897.  
  2898.  
  2899.                                                                        PPPPaaaaggggeeee 44444444
  2900.  
  2901.  
  2902.  
  2903.  
  2904.  
  2905.  
  2906. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2907.  
  2908.  
  2909.  
  2910.      sssseeeettttSSSSccccaaaalllleeeeMMMMiiiinnnnMMMMaaaaxxxx(((())))
  2911.  
  2912.           ilStatus setScaleMinMax(double min, double max)
  2913.  
  2914.  
  2915.           Sets the scale minimum and maximum to _m_i_n and _m_a_x.  The scale
  2916.           minimum and maximum are used during color conversion and display.
  2917.           By default, the scale minimum and maximum track the image minimum
  2918.           and maximum values.
  2919.  
  2920.      sssseeeettttSSSSccccaaaalllleeeeTTTTyyyyppppeeee(((())))
  2921.  
  2922.           ilStatus setScaleType(iflDataType type=iflDataType(0))
  2923.  
  2924.  
  2925.           Sets the scale minimum and maximum to the minimum and maximum values
  2926.           of the data type passed in _t_y_p_e.  If _t_y_p_e is defaulted, then this
  2927.           object's data type is used.  The scale minimum and maximum are used
  2928.           during color conversion.  By default, the scale minimum and maximum
  2929.           track the image minimum and maximum values.
  2930.  
  2931.      sssseeeettttSSSSiiiizzzzeeee(((())))
  2932.  
  2933.           ilStatus setSize(const iflSize &size)
  2934.           ilStatus setSize(int nx, int ny)
  2935.  
  2936.  
  2937.           Sets the image size to the value referenced by _s_i_z_e.  The second
  2938.           versions allows just the _x and _y size to be set.  Returns ilOKAY
  2939.           upon successful completion. See also ggggeeeettttSSSSiiiizzzzeeee().
  2940.  
  2941.      sssseeeettttTTTTiiiilllleeee(((())))
  2942.  
  2943.           ilStatus setTile(int x, int y, int nx, int ny, const void* data,
  2944.                            const ilConfig* config=NULL)
  2945.           ilStatus setTile3D(int x, int y, int z, int nx, int ny, int nz,
  2946.                        const void* data, const ilConfig* config=NULL)
  2947.           ilStatus setSubTile(int x, int y, int nx, int ny, const void* data,
  2948.                         int dx, int dy, int dnx, int dny,
  2949.                         const ilConfig* config=NULL)
  2950.           ilStatus setSubTile3D(int x, int y, int z, int nx, int ny, int nz,
  2951.                                 const void* data, int dx, int dy, int dz, int dnx,
  2952.                           int dny, int dnz, const ilConfig* config=NULL)
  2953.  
  2954.  
  2955.           These functions queue a tile write request with qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and
  2956.           wait for it to complete.  The source tile origin is specified by _x,
  2957.           _y, _z, and the tile size is specified by _n_x, _n_y, _n_z.
  2958.  
  2959.           The 2D versions, sssseeeettttTTTTiiiilllleeee() and sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee(), call the corresponding
  2960.           3D routine with _z set to zero and _n_z set to one.
  2961.  
  2962.  
  2963.  
  2964.  
  2965.                                                                        PPPPaaaaggggeeee 44445555
  2966.  
  2967.  
  2968.  
  2969.  
  2970.  
  2971.  
  2972. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  2973.  
  2974.  
  2975.  
  2976.           sssseeeettttTTTTiiiilllleeee() and sssseeeettttTTTTiiiilllleeee3333DDDD() assume that the source buffer has the same
  2977.           offset and size as the request; sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee() and sssseeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD()
  2978.           allow the source buffer to have a different position and size,
  2979.           specified by _d_x, _d_y, _d_n_x, and _d_n_y (and _d_z and _d_n_z for the 3D
  2980.           version.)
  2981.  
  2982.           See also qqqqSSSSeeeettttTTTTiiiilllleeee3333DDDD(), qqqqSSSSeeeettttSSSSuuuubbbbTTTTiiiilllleeee3333DDDD() and iiiillllGGGGeeeettttCCCCoooonnnnffffiiiigggg().
  2983.  
  2984.      sssseeeettttTTTTiiiilllleeeeRRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnnttttFFFFuuuunnnnccccttttiiiioooonnnn(((())))
  2985.  
  2986.           void setTileRequirementFunction(ilTileRequirementFuncPtr func)   _p_r_o_t_e_c_t_e_d
  2987.  
  2988.  
  2989.           Set a function pointer that is called to override the default
  2990.           implementation of ggggeeeettttIIIInnnnppppuuuuttttTTTTiiiilllleeeeRRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnntttt() in a derived class.
  2991.           This method should be called in the derived-class' constructor.
  2992.           This really should be done as a virtual method, but it has been done
  2993.           this way in order to maintain binary compatibility with IL 3.1.1.
  2994.  
  2995.           In order to override the default ggggeeeettttIIIInnnnppppuuuuttttTTTTiiiilllleeeeRRRReeeeqqqquuuuiiiirrrreeeemmmmeeeennnntttt() in a
  2996.           derived class, you should add a protected method such as
  2997.  
  2998.               ilImageTile* getMyInputTileRequirement(const iflTile3Dint& tile,
  2999.                                                      int c, int nc,
  3000.                                          int* chans, int& inputTileCount);
  3001.  
  3002.  
  3003.           and then call
  3004.  
  3005.               setTileRequirementFunction((ilTileRequirementFuncPtr)
  3006.                                 &MyImage::getMyInputTileRequirement);
  3007.  
  3008.  
  3009.           in the constructor for MMMMyyyyIIIImmmmaaaaggggeeee.
  3010.  
  3011.      sssseeeettttWWWWrrrriiiittttaaaabbbblllleeee(((())))
  3012.  
  3013.           void setWritable(int enable=TRUE)  _p_r_o_t_e_c_t_e_d
  3014.  
  3015.  
  3016.           This function will enable or disable write access to this image.  If
  3017.           _e_n_a_b_l_e is TRUE, then the image will be writable; if FALSE, then the
  3018.           image is not writable.
  3019.  
  3020.      sssseeeettttXXXXssssiiiizzzzeeee(((())))
  3021.  
  3022.           ilStatus setXsize(int nx)
  3023.  
  3024.  
  3025.           Sets the size of the image in the _x-dimension, measured in pixels.
  3026.           Returns ilOKAY upon successful completion.  See special notes on IL
  3027.           image memory order conventions and orientations in the description
  3028.  
  3029.  
  3030.  
  3031.                                                                        PPPPaaaaggggeeee 44446666
  3032.  
  3033.  
  3034.  
  3035.  
  3036.  
  3037.  
  3038. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  3039.  
  3040.  
  3041.  
  3042.           of getXsize().
  3043.  
  3044.      sssseeeettttYYYYssssiiiizzzzeeee(((())))
  3045.  
  3046.           ilStatus setYsize(int ny)
  3047.  
  3048.  
  3049.           Sets the size of the image in the _y-dimension, measured in pixels.
  3050.           Returns ilOKAY upon successful completion.
  3051.  
  3052.      sssseeeettttZZZZssssiiiizzzzeeee(((())))
  3053.  
  3054.           ilStatus setZsize(int nz)
  3055.  
  3056.  
  3057.           Sets the size of the image in the _z-dimension, measured in pixels.
  3058.           Returns ilOKAY upon successful completion.
  3059.  
  3060.      uuuunnnnlllloooocccckkkkPPPPaaaaggggeeee(((())))
  3061.  
  3062.           void unlockPage(ilPage *page)
  3063.  
  3064.  
  3065.           This is the single page version of unlockPageSet().  It releases a
  3066.           page previously ``locked'' by lockPage().
  3067.  
  3068.      uuuunnnnlllloooocccckkkkPPPPaaaaggggeeeeSSSSeeeetttt(((())))
  3069.  
  3070.           virtual void unlockPageSet(ilLockRequest* set, int count=1)
  3071.  
  3072.  
  3073.           This function releases a set of pages previously ``locked'' with
  3074.           lockPageSet().  The _s_e_t parameter is a pointer to an array of _c_o_u_n_t
  3075.           ilLockRequest structures.
  3076.  
  3077. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  3078.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  3079.      addResetCallback(), alterAction(), anyAltered(), clearAllowed(),
  3080.      clearSet(), clearStatus(), deleteRelated(), disableAltered(),
  3081.      dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
  3082.      getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
  3083.      getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
  3084.      getParent(), getProp(), getProp(), getPropSet(), getPtrProp(),
  3085.      getRelatedChild(), getRelatedDelete(), getRelatedType(), getStatus(),
  3086.      hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
  3087.      isAltered(), isEnabled(), isRelated(), isSet(), markSet(), mpUnlock(),
  3088.      neverReset(), newRelatedType(), removeParent(), removeProp(),
  3089.      removeResetCallback(), reset(), resetAltered(), resetCheck(),
  3090.      setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
  3091.      setEnabled(), setParent(), setProp(), setPropAltered(),
  3092.      setRelatedDelete(), setRelatedType(), setStatus(), stopWatching(),
  3093.      unalterable(), watch(), watchNotify()
  3094.  
  3095.  
  3096.  
  3097.                                                                        PPPPaaaaggggeeee 44447777
  3098.  
  3099.  
  3100.  
  3101.  
  3102.  
  3103.  
  3104. iiiillllIIIImmmmaaaaggggeeee((((3333))))         IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll         iiiillllIIIImmmmaaaaggggeeee((((3333))))
  3105.  
  3106.  
  3107.  
  3108. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  3109.      ilCacheImg, ilDisplayImg, ilFileImg, iflColormap, ilMemoryImg, ilOpImg,
  3110.      ilSubImg, _i_l/_i_l_I_m_a_g_e._h, _i_f_l/_i_f_l_D_a_t_a_T_y_p_e_s._h
  3111.  
  3112.      Please refer to the _I_m_a_g_e_V_i_s_i_o_n _L_i_b_r_a_r_y _P_r_o_g_r_a_m_m_i_n_g _G_u_i_d_e for a full
  3113.      description of overall concepts and architecture.
  3114.  
  3115. NNNNOOOOTTTTEEEESSSS
  3116.      Although the ilImage class contains no pure virtual functions, it should
  3117.      only be used to derive new classes, never directly created as an object.
  3118.      However, a pointer to an ilImage can be declared in order to support
  3119.      polymorphism.
  3120.  
  3121.  
  3122.  
  3123.  
  3124.  
  3125.  
  3126.  
  3127.  
  3128.  
  3129.  
  3130.  
  3131.  
  3132.  
  3133.  
  3134.  
  3135.  
  3136.  
  3137.  
  3138.  
  3139.  
  3140.  
  3141.  
  3142.  
  3143.  
  3144.  
  3145.  
  3146.  
  3147.  
  3148.  
  3149.  
  3150.  
  3151.  
  3152.  
  3153.  
  3154.  
  3155.  
  3156.  
  3157.  
  3158.  
  3159.  
  3160.  
  3161.  
  3162.  
  3163.                                                                        PPPPaaaaggggeeee 44448888
  3164.  
  3165.  
  3166.  
  3167.